openstack/heat
Code Issues Proposed changes
e6566569c4
heat/doc
History
Thomas Spatzier 315aa5754a Fix syntax description of HOT get_attr function 
Fix syntax description of get_attr function in HOT specification.
Colon instead of comma was used in array.

Contributes to blueprint hot-specification

Change-Id: I8007d476093ecd5be41020025b486147a5ac038b
2013-08-13 15:58:53 +02:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Fix syntax description of HOT get_attr function 2013-08-13 15:58:53 +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