openstack/heat

History

huangtianhua 77e5072621 Allow function 'yaql' as condition function Allow 'yaql' in condition definition, like: parameters: ServiceNames: type: comma_delimited_list default: ['neutron', 'heat'] conditions: contains_neutron: yaql: expression: $.data.service_names.contains('neutron') data: service_names: get_param: ServiceNames Closes-Bug: #1693093 Change-Id: I83a540336c01a696780621fb2b39486a6abf0917		2017-05-25 01:19:26 +00:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Allow function 'yaql' as condition function	2017-05-25 01:19:26 +00: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.