mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-11-04 13:22:36 +00:00
687946be0a
to the existing SourceForge documentation for now until we have an opportunity to add the documentation for System X. This should be done after the System P documentation is in good shape to mimic.
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