2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2026-11-19 00:42:29 +00:00
Files
xcat-core/docs
Daniel Hilst 7d8b196573 chore(release): bump version to 2.19.2
2.19.1 is tagged and published, so the 2.19 branch is now the source of
the next patch release. Version and the documentation release are both
set to 2.19.2. The documentation release was still 2.17.0, which is why
every published page of the 2.19 series is titled xCAT 2.17.0.

Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
2026-09-25 18:15:01 -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