History

Shengjie Min 65e0706874 update on_devstack doc udpate the prebuilt-jeos-image from F16 to F17 Change-Id: Iae1456e4811c029494a8c2878c9bf0c3221bc43a Fixes: bug #1180416		2013-05-21 11:09:21 +01:00
..
docbkx	ReST API: Translate the documentation to WADL	2013-04-04 19:25:24 +02:00
source	update on_devstack doc	2013-05-21 11:09:21 +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