mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00

History

Victor Hu 971b437227 Clean up of the kdump documentation (#4874 )

* Clean up the formatting of the documentation, remove references to SLES 10 as this OS is out of service.  Remove URLs that will become old over time

* enhance kdump document

* polished

2018-03-07 16:11:26 +08:00

source

Clean up of the kdump documentation (#4874 )

2018-03-07 16:11:26 +08: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.md

2017-05-09 17:00:09 -04:00

README.md

Welcome to the xCAT documentation

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

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