mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-17 03:40:39 +00:00

Files

Bin Xu 8b8a82627b The tool to get xCAT node range operation performance baseline (#2681 ) (#2916 )

* Feature #2681, to add a script in xCAT-test to get the performance baseline for node range operation.

* adopt review comments in PR#2916:
  1, add the rst file for xcatperftest (#2681)
  2, using /bin/bash as script executor
  3, FILES in manpage should not be in the same line
  4, minor adjustment if PERF_NOCREATE/PERF_DRYRUN is set

2017-05-09 04:49:15 -05:00

source

The tool to get xCAT node range operation performance baseline (#2681 ) (#2916 )

2017-05-09 04:49:15 -05: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