openstack
/
heat
Code Issues Proposed changes
heat/doc
History
Steven Hardy 092222de42 heat : Getting started updates for grizzly 
Update GettingStarted to drop references to F16/essex and add the
password sed which is required when running grizzly installed via
tools/openstack on Fedora

Change-Id: I08d265e2e2388b54a6aa9f47c4930c32f71f3e93
 		2013-04-09 10:32:13 +01:00
..
docbkx ReST API: Translate the documentation to WADL 2013-04-04 19:25:24 +02:00
source heat : Getting started updates for grizzly 2013-04-09 10:32:13 +01: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