openstack/deb-heat
Code Issues Proposed changes
7809499dab
deb-heat/doc
History
Steve Baker 8282ab4ddb Fix H233 in sphinx config 
This is being flagged in local flake8 runs.

Change-Id: I99f05996711b3851811940ad5741e96d5ae61ed6
2013-09-06 11:42:36 +12:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Fix H233 in sphinx config 2013-09-06 11:42:36 +12: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