2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00
Victor Hu b6456132be Add a note into the packimage man page to help clarify that (#2027)
during the time of running genimage, the rootimg file is unavail
to be served to the compute nodes
2016-10-27 14:17:12 +08:00
..
2016-07-12 13:47:19 -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 or update sphinx (See: http://pip.readthedocs.org/)

     pip install sphinx  
    

    or

     pip install sphinx --upgrade 
    
  • Using pip, install ReadTheDocs theme

    pip install sphinx_rtd_theme
    
  • 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