mirror of https://github.com/xcat2/xcat-core.git synced 2026-04-03 07:26:27 +00:00

Files

yangsong 502e952f1e Revert "merge master(commit:a183e3b8f241fb168b830dbe3f8f6f5b40fe1834) to 2.13 branch" (#3934 )

* Revert "Revert "Disable the ssh prompt when connecting the openbmc console (#3815) (#3932)" (#3933)"

This reverts commit 63c541428f.

* Revert "Disable the ssh prompt when connecting the openbmc console (#3815) (#3932)"

This reverts commit 02cf849c23.

* Revert "merge master(commit:a183e3b8f241fb168b830dbe3f8f6f5b40fe1834) to 2.13 branch (#3929)"

This reverts commit 294d59a307.

2017-09-15 17:16:57 +08:00

source

Revert "merge master(commit:a183e3b8f241fb168b830dbe3f8f6f5b40fe1834) to 2.13 branch" (#3934 )

2017-09-15 17:16:57 +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