mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-21 19:22:05 +00:00
bb279bd76f
- categorize into topics without "xCAT" in the heading since the topics are all related to xCAT - Alphabetize the topics to make it easier to find - create sub directories for the topics to contain the documentation - broke down some of the docs to multiple files to help ease of readability
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