History

Steven Hardy 144f5e49b9 Add support status to docs for properties I thought we already had this, but inspection of the generated docs reveals that we only do class-level docs for the support status, not exposing those defined in the schema. Adding the properties support status should help reduce user confusion when new properties are added between releases. Change-Id: I5f3228161e57daad73cbafc124c4fad05c68d3d6 Closes-Bug: 1376868		2015-01-15 09:41:57 +00:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Add support status to docs for properties	2015-01-15 09:41:57 +00: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.