mirror of
https://github.com/xcat2/xcat-core.git
synced 2026-10-02 00:41:42 +00:00
Daniel Hilst
733bc3219c
Read the Docs takes the version in the title of each page from release in docs/source/conf.py, which was last set for 2.17.0. Every build since, 2.18.x and 2.19.0 included, is titled "xCAT 2.17.0 documentation". Set it to 2.20.0, the Version of master. Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
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