History

Angus Salkeld 223671658f Use oslo.sphinx for the doc templates This is to make the look of the developer docs consistent with the other projects. Change-Id: If538b5fcc974606c1628ca4a510cd1f34cb631a2		2013-08-23 12:59:54 +10:00
..
docbkx	Rename Quantum to Neutron	2013-08-06 22:08:27 -07:00
source	Use oslo.sphinx for the doc templates	2013-08-23 12:59:54 +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