diff --git a/docs/README.md b/docs/README.md index 8b4779eaf..c15ea02a1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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`