openstack/heat

History

Chmouel Boudjnah 8c73c49dfe Skip tests when loading plugins All python files in plugins were automatically loaded which would add the dependencies of the tests to the plugins. Let skip the files in the .tests. namespace Closes-Bug: #1292655 Change-Id: I25eac87559b5852e9645fbb84c8b4d07b4c1ff42		2014-04-30 23:19:57 +02:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Skip tests when loading plugins	2014-04-30 23:19:57 +02: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	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.