mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 11:42:05 +00:00

History

Victor Hu b90fe27096 Created the security notices that were on SF for 2015 into the xCAT

documentation so we can clean up the GitHub Wiki to remove security
notices from that location. I think saving the last 2 years is sufficient
and probably should get removed over time.

2016-08-18 09:29:42 -04:00

source

Created the security notices that were on SF for 2015 into the xCAT

2016-08-18 09:29:42 -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