openstack/heat

History

Diane Fleming e9916f7fdd update pom.xml files with clouddocs-maven-plugin version 1.12.2 Change-Id: I5d4633bd53697deafe5c2348d581b81186e6ab1c author: diane fleming		2014-01-10 13:02:32 -06:00
..
docbkx	update pom.xml files with clouddocs-maven-plugin version 1.12.2	2014-01-10 13:02:32 -06:00
source	Add documentation for multi-engine	2014-01-03 13:38:20 -06:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
README.rst	Fix a typo in the README for docs	2013-12-24 16:08:41 +02:00

Building the developer docs

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

Dependencies

You'll need to install python Sphinx package and oslo.sphinx package:

sudo pip install sphinx oslo.sphinx

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

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.