History

Angus Salkeld 3c11589e37 Make the doc look a bit better and give a better overview. (styles mostly copied from Ceilometer docs) Change-Id: Ie3eab4f579e0c16a09634faffb90e96a872d5d84		2013-02-11 14:49:52 +11:00
..
docbkx	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
source	Make the doc look a bit better and give a better overview.	2013-02-11 14:49:52 +11: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