2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-01 19:17:06 +00:00
Mark Gurevich 7346de78c6 Revert "Remove man pages for kit related commands"
This reverts commit 36116078ac40b282865f06246ee09ebffe475b8f.
2019-10-03 11:45:18 -04:00
..

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