mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-12-25 10:21:44 +00:00
657a1b6122
Apparently the doc was contributed some time ago and is live (https://xcat-docs.readthedocs.io/en/stable/advanced/networks/vlan/index.html) but not referenced in the toc for networking (https://xcat-docs.readthedocs.io/en/stable/advanced/networks/index.html)
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 or update sphinx (See: https://pip.readthedocs.io/)
pip install sphinxor
pip install sphinx --upgrade -
Install ReadTheDocs theme
pip install sphinx_rtd_theme -
Build the Docs
cd xcat-core/docs make html -
View the documentation by pointing a browser to:
xcat-core/docs/build/html/index.html