History

Angus Salkeld d00b12cec4 Add some docs on how to setup Ceilometer to use Alarms We need to use Ceilometer's mongo backend if we want to use alarms as the sql backend is missing a feature. Works around bug #1223710 Change-Id: Ib569cfd650ce14480496530e7bbf1b2f71a24c02		2013-10-10 10:53:58 +01:00
..
docbkx	Replace OpenStack LLC with OpenStack Foundation	2013-09-20 02:43:12 +08:00
source	Add some docs on how to setup Ceilometer to use Alarms	2013-10-10 10:53:58 +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