openstack
/
heat
Code Issues Proposed changes
heat/doc
History
Thomas Spatzier 235cbf217a Fix inconsitencies in HOT template guide and spec 
Fix description of outputs section in the HOT specification, and thus make it
consistent with the HOT template guide (which is correct).

Also fix incorrect uses of the native server resource's resource name and
attribute names.

Change-Id: I98643873c370d03619ee7df9c7e09b2cdf3cf08c
Closes-Bug: #1233318
 		2013-09-30 20:49:52 +02:00
..
docbkx Replace OpenStack LLC with OpenStack Foundation 2013-09-20 02:43:12 +08:00
source Fix inconsitencies in HOT template guide and spec 2013-09-30 20:49:52 +02: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 A new documention structure, ready for contributions 2012-12-19 10:22:35 +13:00

README.rst

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the cinder modules.

sudo yum install python-sphinx
sudo pip-python install sphinxcontrib-httpdomain

Use make

Just type make:

make

Look in the Makefile for more targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html