openstack/heat

History

Peter Razumovsky 00b2c9da15 Fix [H405] pep rule in doc/source Implements bp docstring-improvements Change-Id: I8a90a6fa677a89135cfad13984280e8fb94e8b0c		2015-10-08 15:13:52 +03:00
..
docbkx	Change "ReST" to "REST" in developer doc	2015-06-03 21:26:29 +05:30
source	Fix [H405] pep rule in doc/source	2015-10-08 15:13:52 +03: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.