mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-28 06:23:26 +00:00

History

Victor Hu d8d18d844d Separate out the hardware management section into multiple files.

This allows us to better describe certain commands in more detail.
rcons file has changes pertaining to OpenBMC specific information

advanced hardware commands have not been revised, but I went through
the basic commands.

2017-05-09 16:56:01 -04:00

source

Separate out the hardware management section into multiple files.

2017-05-09 16:56:01 -04:00

make.bat

Staging files under xcat-doc/doc to get moved to xcat-core project

2015-08-20 15:54:56 -04:00

Makefile

Remove the whole build directory for the docs instead of just

2015-10-07 15:25:44 -04:00

README.md

Update README file

2016-07-12 13:47:19 -04:00

README.md

Welcome to the xCAT documentation

The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/

Status:

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 sphinx  
```
or
```
 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