openstack/heat

History

Zane Bitter bca8b8e804 Allow referencing conditions by name This change allows reference with other conditions by name in definition of a condition, something like: conditions: cd1: {equals: [{get_param: env_type}, 'prod']} cd2: {not: cd1} cd3: {equals: [{get_param: zone}, 'fujian']} cd4: {and: [cd1, cd3]} Change-Id: I6a0a00c23aa7d559dedd6998adaa7962d607f315 Co-Authored-By: huangtianhua <huangtianhua@huawei.com> Blueprint: support-conditions-function Related-Bug: #1621529		2016-09-12 21:39:01 -04:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Allow referencing conditions by name	2016-09-12 21:39:01 -04: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.