openstack/deb-heat
Code Issues Proposed changes
ae28bf4c89
deb-heat/doc
History
Angus Salkeld ae28bf4c89 Remove references to the multiple config files 
Only refer to heat.conf in the docs and scripts.
For install.sh copy the iniset() function from devstack
to assist in setting some semi-sane defaults.

Change-Id: I933891e35103c003f1272bc89c7b42d2ad76697b
2013-09-02 10:43:21 +10:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Remove references to the multiple config files 2013-09-02 10:43:21 +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