2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2026-11-21 09:52:17 +00:00
Files
xcat-core/docs
Daniel Hilst 1d148d1847 Merge branch 'master' into fix/xcattest-table-value-class
No conflicts. master gained #7990, #7979 and #7977 after the previous merge.

Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
2026-10-29 15:01:18 -03:00
..
2024-02-13 03:01:02 +01:00

Welcome to the xCAT documentation

The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (.rst).

Building Docs

  • Clone this project

  • Install dependencies (See: https://pip.readthedocs.io/)

    pip install --user -r requirements.txt
    
  • Build the Docs

    cd xcat-core/docs
    make html
    
  • View the documentation by pointing a browser to: xcat-core/docs/build/html/index.html