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.
Peter Razumovsky e3e8e06fe7 Fix typos in hot_spec documentation 7 years ago
docbkx Change "ReST" to "REST" in developer doc 7 years ago
source Fix typos in hot_spec documentation 7 years 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 9 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.