History

huangtianhua 70c4ab3fcf Support 'conditions' section for templates This changes: 1. Support 'Conditions' for AWSTemplateFormatVersion: 2010-09-09 2. Support 'conditions' for heat_template_version: 2016-10-14 3. There is no need to add a new HeatTemplateFormatVersion template, because we decide to support conditions in AWSTemplateFormatVersion and heat_template_version: 2016-10-14, so remove the HeatTemplateFormatVersion.2016-10-14 4. Move the definition of function 'equals' to hot/functions.py 5. Mark 'equals' as condition function which supported in conditions. Change-Id: I2e7bdfa1c2052e75f35f2bd0003cdc170188d8b8 Blueprint: support-conditions-function		2016-08-03 09:17:31 +08:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Support 'conditions' section for templates	2016-08-03 09:17:31 +08: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.