openstack/heat

History

Steve Baker 0eb93cbf33 Use setuptools to install contrib plugins This change creates a pbr setup.cfg and specifies a data_files entry to install the contrib plugin source into the /usr/lib/heat plugin directory. This change also temporarily disables docs building for contrib resoures until the transition to stevedore is fully complete. Change-Id: I1c91aee20f72dc2a5a049e67de1d6d7cbabda241		2014-08-13 20:12:29 -05:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Use setuptools to install contrib plugins	2014-08-13 20:12:29 -05: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.