openstack/heat

History

Andreas Jaeger 2ed2e3f170 Remove unused pngmath Sphinx extension There's no RST file that uses ".. math" and thus the pngmath Sphinx extension is not used and can get removed. Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668		2016-02-29 19:50:33 +01:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Remove unused pngmath Sphinx extension	2016-02-29 19:50:33 +01: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.