History

huangtianhua f87114a527 Fix syntax error in docs There are several syntax errors in docs. The patch will add missing punctuation, remove extra whitespace, and change the "heat-api-engine" to "heat-engine" in heat-engine.rst. Change-Id: I67dcad5e0e0a1f71a67ab8fc4311d96db4820c29		2014-01-18 14:50:52 +08:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Fix syntax error in docs	2014-01-18 14:50:52 +08: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.