2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-04 12:30:10 +00:00
Victor Hu 62a2dd804d Merge pull request #1262 from xuweibj/I846
Fix issue 846, update mknb doc
2016-06-08 19:47:40 -04:00
..
2016-05-03 13:21:53 -04:00

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