xcat-core

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 dependencies (See: https://pip.readthedocs.io/)

   pip install --user -r requirements.txt
  

• Build the Docs

   cd xcat-core/docs
   make html
  

• View the documentation by pointing a browser to: xcat-core/docs/build/html/index.html

This site is open source. Improve this page.