mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-24 15:05:36 +00:00

Files

chenglch 1938bd9a87 Add description for the issue that may lose log

This commit add descritpion for `dbtracelevel` entry in site table
to help the user find the detail solution if the log is lost due
to the issue from rsyslog side.

partial-issue: #3910

2017-09-14 06:07:43 -04:00

source

Add description for the issue that may lose log

2017-09-14 06:07:43 -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.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