History

Angus Salkeld b37062b98d Add support for pass through references To make template resources more transparent we now support the user adding an output "OS::stack_id" to a nested stack. This is then used by get_resource in the outer stack. Note: it is expected to use this as follows: outputs: OS::stack_id: value: {get_resource: my_server} bp env-nested-usability Change-Id: I6016699514e75bd88c27f9f8f7d871b39d31343d		2014-12-03 13:16:53 +10:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Add support for pass through references	2014-12-03 13:16:53 +10: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.