mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00

History

Matt Ezell 2304b0ef50 Add regex helpers

a2idx: Turns an ASCII character into an index (a=1, b=2, etc)
a2zidx: Turns an ASCII character into a 0-index (a=0, b=1, etc)
dim2idx: Turns dimensions (eg row, column, rack-unit) into an index
skip: Return an index where some items are 'skipped'
ipadd: Add a value to an IP address

2017-09-10 23:02:06 -04:00

source

Add regex helpers

2017-09-10 23:02:06 -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