openstack/heat

History

Zane Bitter 5cdd8b8b09 Add a resource_facade intrinsic function to HOT Add a native version of the function, rather than continue to rely on Fn::ResourceFacade from the Heat-flavoured-cfn templates. Closes-bug: #1299205 Change-Id: Iee118aeaa72d59e4d6a27ed487b99e9aba9779cd		2014-04-01 11:04:19 -04:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Add a resource_facade intrinsic function to HOT	2014-04-01 11:04:19 -04:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13: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.