openstack/heat

History

ricolin 222a8ac5e9 [policy in code] part 7 add sample and releasenote Since we're moving all policy into code and documenting it there we should generate those docs automatically, so they are less likely to be out-of-date. Also add releasenote for ops to aware that Heat is now using policies in code and their Orchestration service needs to avoid depends on policy.json file if file not exist, since there is no such file by default after this patch. Partially-Implements: bp policy-in-code Change-Id: I25fc5a110b1fe515918e042f220c23ac9a7e811f		2017-12-13 10:58:56 +08:00
..
source	[policy in code] part 7 add sample and releasenote	2017-12-13 10:58:56 +08:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	Makefile option to build xml docs	2014-07-02 22:08:01 +02:00
README.rst	Switch over to oslosphinx	2014-02-13 18:45:57 +01: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 oslosphinx package:

sudo pip install sphinx oslosphinx

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.