xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-11-03 21:02:34 +00:00
Code Issues Releases Wiki Activity

Some additional formatting in the README

Browse Source
This commit is contained in:
Victor Hu
2019-04-11 15:35:54 -04:00
parent 8251a32bdb
commit f4d291954b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README.md
View File

@@ -2,17 +2,17 @@
The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (`.rst`).
## Building docs locally
## Building Docs
* Clone this project
* Install or update sphinx (See: https://pip.readthedocs.io/)
```
pip install sphinx
pip install sphinx
```
or
```
pip install sphinx --upgrade
pip install sphinx --upgrade
```
* Install ReadTheDocs theme