mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-06-18 20:30:56 +00:00
74769080c8
for the supported options based on the possible values that are currently allowed to be returned. As more data is added, the code should be able to handle the printing of the data automatically
Welcome to the xCAT documentation
The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/
The documentation project is written in restructured text (.rst) using Sphinx and hosted on ReadTheDocs.
Building Documentation
-
Clone the project
-
Using pip, install or update sphinx (See: http://pip.readthedocs.org/)
pip install sphinxor
pip install sphinx --upgrade -
Using pip, install ReadTheDocs theme
pip install sphinx_rtd_theme -
Build the Docs
cd xcat-core/docs make html -
View the docs by opening index.html from a web browser under xcat-core/docs/build/html/index.html