mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-09-26 20:18:19 +00:00
d0ed517ee2
* Add section for OpenBMC rflash in admin-guide, link this section to CORAL reference section * enhance rflash unattended doc * Add libnl3 to ib.rhels7.ppc64le.pkglist * Reverse installing xCAT-openbmc-py by default so we can require python dependencies * Adding documentation for installing xCAT-openbmc-py * enhance rflash doc * Fix indent problem for the comment lines For the usability issue, add more spaces to avoid of some errors when deleting the `#`. * Install first, then performance section * Modify all fullwidth colon in test case * remove the dependency, Load SOAP module dynamically * Add doc to enable goconserver by default Add the steps in documentation to enable goconserver by default. * Use makegocons instead of makeconservercf during discovery and provision * check if agent exists in process_request and give more clear message. * add usercase for xcat-inventory * Not start agent when no valid nodes (#4915)
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