openstack/heat

History

Javeme eb68e1f55e remove the mutable default arguments "[]" or "{}" remove the default arguments "[]" or "{}" when the function is defined. ref: http://docs.python-guide.org/en/latest/writing/gotchas/ Change-Id: I93de22c6b3a48c3a0e6365756f8b6b5839844826		2015-12-16 16:48:51 +08:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	remove the mutable default arguments "[]" or "{}"	2015-12-16 16:48:51 +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.