xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
Code Issues Releases Wiki Activity
xcat-core/docs
History
Weihua Hu bcd01d19ba Add documentation in RTD for how to use an xCAT docker image (#6222) 
* Add docs for xcat container 2.14.6

* Modify depending on comments

* remove outdated documents

* Modify depending on comments

* update for comments

* update depending on comments

* update depending on mark's comment

* update depending on ertao's comment

* modify depending on Mark's comments

* modify depending on xiaopeng's comment
2019-04-23 13:15:58 +08:00
..
source
Add documentation in RTD for how to use an xCAT docker image (#6222)
2019-04-23 13:15:58 +08: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
Some additional formatting in the README
2019-04-11 15:35:54 -04:00

README.md

Welcome to the xCAT documentation

The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (.rst).

Building Docs

  • Clone this project

  • Install or update sphinx (See: https://pip.readthedocs.io/)

    pip install sphinx

    or

    pip install sphinx --upgrade

  • Install ReadTheDocs theme

    pip install sphinx_rtd_theme

  • Build the Docs

    cd xcat-core/docs
make html

  • View the documentation by pointing a browser to: xcat-core/docs/build/html/index.html