openstack/heat

History

huangtianhua 306ee63083 Add an example on how to use 'contains' as condition This adds an example in docs on how to use newly added function 'contains' as condition. Change-Id: I9c5f314925f5b6592742cb4eb04e4c8247ec743c		2017-06-23 14:26:51 +08:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Add an example on how to use 'contains' as condition	2017-06-23 14:26:51 +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.