openstack/heat

History

Andreas Jaeger 929fa9cfdd Remove heat-cli-guide The heat command line clients are documented now better in the OpenStack End User Guide: http://docs.openstack.org/user-guide/content/heat-stack-create.html http://docs.openstack.org/user-guide/content/heat_client_commands.html The content here is thus not needed anymore, as the README.rst says: "This documentation should eventually end up in the OpenStack documentation repositories `api-site` and `openstack-manuals`." Change-Id: I297252d7f8eee383ce6252a5db44111630fbe29b		2014-01-15 08:41:48 +01:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Add documentation for multi-engine	2014-01-03 13:38:20 -06: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	Fix a typo in the README for docs	2013-12-24 16:08:41 +02: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 oslo.sphinx package:

sudo pip install sphinx oslo.sphinx

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.