History

Matthew Printz e4a6926d5f Fix typo in HOT template guide Under the "Template input parameters" section, there was a typo in the following sentence: "For example, the following definition for the instance_type parameter would select the ‘m1.small’ flavor unless specified otherwise be the user." Closes-Bug: 1339269 Change-Id: I59a170407669c74d23f36b232b3d492e52ce5eac		2014-07-08 15:31:49 -05:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Fix typo in HOT template guide	2014-07-08 15:31:49 -05: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.