openstack/heat

History

Steven Hardy 0d99ede046 HOT version 2015-10-15, remove Fn::Select Bump the HOT version for the Liberty release, currently planned for 2015-10-15 [1] This is the same as 2015-04-30 other than the removal of the last remaining CFN compatible function, Fn::Select, which should now be replaced by path based attributes/parameters, e.g: {get_attr: [aResource, anAttribute, <list index>]} {get_param: [aListParam, <list index>]} [1] https://wiki.openstack.org/wiki/Liberty_Release_Schedule Change-Id: I10e5b12b84a6de01dd3f8a37a2d6cb644f319049		2015-06-26 10:21:50 +01:00
..
docbkx	Change "ReST" to "REST" in developer doc	2015-06-03 21:26:29 +05:30
source	HOT version 2015-10-15, remove Fn::Select	2015-06-26 10:21:50 +01: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.