mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-22 11:42:05 +00:00
bb48f7f93d
basic configuration over to the install guide so that we do not need to mention that in the guide. - split the configure_xcat.rst file into separate files under a configure directory so that users can go from one section to another without being overloaded with information
Welcome to the xCAT documentation
We are working on improving the documentation. The latest docs are here: http://xcat-docs.readthedocs.org/en/latest/
The documentation project is written in restructured text (.rst) using Sphinx. To build the docs locally:
-
Clone the project
-
Using pip, install sphinx (See: http://pip.readthedocs.org/)
pip install sphinx
- 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