2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00
Victor Hu d8d18d844d Separate out the hardware management section into multiple files.
This allows us to better describe certain commands in more detail.
rcons file has changes pertaining to OpenBMC specific information

advanced hardware commands have not been revised, but I went through
the basic commands.
2017-05-09 16:56:01 -04: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