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

Update README.md

Browse Source 
Fix the badges for RTD, this is in markdown syntax
This commit is contained in:
Victor Hu 2016-05-03 13:12:58 -04:00
parent ef5cdcc3a8
commit 41d6e9aca6
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/README.md
View File

@ -1,23 +1,27 @@
# Welcome to the xCAT documentation
.. image:: https://readthedocs.org/projects/xcat-doc/badge/?version=latest
The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/
We are working on improving the documentation. The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/
Status:
<img src="https://readthedocs.org/projects/xcat-docs/badge/?version=latest">
<img src="https://readthedocs.org/projects/xcat-docs/badge/?version=2.11">
The documentation project is written in restructured text (.rst) using Sphinx.
To build the docs locally:
The documentation project is written in restructured text (.rst) using Sphinx and hosted on ReadTheDocs.
## Building Documentation
* Clone the project
* Using pip, install sphinx (See: http://pip.readthedocs.org/)
```
```
pip install sphinx
```
```
* 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