openstack/deb-heat
Code Issues Proposed changes
0dc3a1e3ab
deb-heat/doc
History
Steven Dake ed0fb7e823 Rename Quantum to Neutron 
quantumclient is gone upstream and has been replaced by neutronclient.

This patch retains the OS::Quantum::XX namespace

Fixes: bug #1197208

Change-Id: Id48f9598ea1884132d411ad533770ae49494102b
2013-08-06 22:08:27 -07:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Functions documentation cleanup. 2013-07-27 11:37:32 +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