Files
heat/doc
Angus Salkeld 08431c7c06 Add "parameter_defaults" to the environment
This give the user a way to set defaults recursively down nested stacks
without having to create the parameter in every template (it's ignored
if the template does not have the parameter).

blueprint env-nested-usability
Change-Id: Ie6b4481417204a527d322fd532c341b9acbce473
2014-12-15 09:44:11 +10:00
..
2014-01-15 08:41:48 +01:00
2014-07-02 22:08:01 +02:00
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.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.