mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-22 11:42:05 +00:00
2b020917f5
the output of bmcdiscover. The hwtype=bmc is not displayed anymore and will cause confusion when users are trying to define the predefined nodes using the output from bmcdiscover or the examples in our documentation
Welcome to the xCAT documentation
The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/
Status:
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