openstack/heat

History

Jason Dunsmore 152b03b09b Add default release names for template versions Release version names are easier for template authors to remember than seemingly arbitrary dates. It should also make it clearer to new Heat users that heat_template_version is not like a BIND zone file version (which would be incremented with each version of the template). Change-Id: Iae9b6a676702b2a115b18fdfb1ab2afbe5faacde blueprint support-alias-for-heat-template-version-names		2016-06-28 10:19:24 -05:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Add default release names for template versions	2016-06-28 10:19:24 -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.