openstack
/
heat
Code Issues Proposed changes
heat/doc
History
Angus Salkeld ffc55433d4 Fix the main docs index page 
This magic new line makes the main index look a lot better.
It wasn't showing the "HOT templates" level.

Change-Id: I3f7fb65911a4b0f3ad57ddf22c00ec8236261c7e
 		2013-08-23 09:56:13 +10:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Fix the main docs index page 2013-08-23 09:56:13 +10: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