xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00
Code Issues Releases Wiki Activity
xcat-core/docs
History
xuweibj 014de562f9 Merge pull request #1111 from whowutwut/install_disk 
Modify the getinstdisk to create files called /tmp/xcat.install_disk to indicate xCAT related files  (DO NOT MERGE until after branch 2.12)
2016-06-07 14:28:00 +08:00
..
source
Merge pull request #1111 from whowutwut/install_disk
2016-06-07 14:28:00 +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
Update README.md
2016-05-03 13:21:53 -04:00

README.md

Welcome to the xCAT documentation

The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/

Status:
Documentation Status Documentation Status

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