mirror of
https://github.com/xcat2/xcat-core.git
synced 2026-09-28 16:20:51 +00:00
Daniel Hilst
2c7a6f0786
The release information page lists every release up to 2.18.0. 2.18.2, 2.19.0 and 2.19.1 are published and absent from it, so a reader cannot tell from the documentation which releases exist, when each one shipped, or where its notes are. docs/source/overview/_files/2.19.x.csv is new and holds the 2.19.0 and 2.19.1 rows, xcat2_release.rst gains its section above 2.18.x, and 2.18.x.csv gains the 2.18.2 row. Each date is the date of that release on GitHub. 2.18.1 has no GitHub release of its own, so it has no row. 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