xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-24 15:05:36 +00:00
Code Issues Releases Wiki Activity
Files
b678ec0aa21b3c99990ae3832b46dea47c7d03ca
xcat-core/docs
History
jose_d b678ec0aa2 increase memory in kvm guide 
with current CentOS, download of kickstart file will fail when 1G memory is used.
I believe it's related to this RHEL bug, https://bugzilla.redhat.com/show_bug.cgi?id=1595369, "Bug 1595369 - rhel 7.5 installation fails with 1GB ram ".
2019-08-26 19:23:04 +02:00
..
source
increase memory in kvm guide
2019-08-26 19:23:04 +02:00
make.bat
Staging files under xcat-doc/doc to get moved to xcat-core project
2015-08-20 15:54:56 -04:00
Makefile
Remove the whole build directory for the docs instead of just
2015-10-07 15:25:44 -04:00
README.md
Some additional formatting in the README
2019-04-11 15:35:54 -04:00

README.md

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