xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-23 19:50:21 +00:00
Code Issues Releases Wiki Activity

Update the README under the docs directory

Browse Source
This commit is contained in:
Victor Hu
2019-04-11 15:34:32 -04:00
parent a3cf49f4c5
commit 8251a32bdb
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/README.md
View File

@@ -1,14 +1,12 @@
# Welcome to the xCAT documentation
The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/
The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (`.rst`).
The documentation project is written in restructured text (.rst) using Sphinx and hosted on ReadTheDocs.
## Building docs locally
## Building Documentation
* Clone this project
* Clone the project
* Using pip, install or update sphinx (See: http://pip.readthedocs.org/)
* Install or update sphinx (See: https://pip.readthedocs.io/)
```
pip install sphinx
```
@@ -17,15 +15,15 @@ The documentation project is written in restructured text (.rst) using Sphinx an
pip install sphinx --upgrade
```
* Using pip, install ReadTheDocs theme
* Install ReadTheDocs theme
```
pip install sphinx_rtd_theme
```
* Build the Docs
```
cd xcat-core/docs
make html
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
* View the documentation by pointing a browser to: `xcat-core/docs/build/html/index.html`