OpenStack Orchestration (Heat)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Matthias Runge 779b39c975 Replace Fedora test image with F32 1 year ago
source Replace Fedora test image with F32 1 year ago
.gitignore A new documention structure, ready for contributions 10 years ago
Makefile Makefile option to build xml docs 8 years ago
README.rst Switch over to oslosphinx 8 years ago
requirements.txt Switch to newer openstackdocstheme and reno versions 2 years ago


Building the developer docs

For user and admin docs, go to the directory doc/docbkx.


You'll need to install python Sphinx package and oslosphinx package:

sudo pip install sphinx oslosphinx

If you are using the virtualenv you'll need to install them in the virtualenv.

Get Help

Just type make to get help:


It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.