History

Steve Baker c0c1768e4a Consolidated api-paste.ini file Load a single api-paste.ini file, specified by config Delete unused paste.ini files Update docs for new paste.ini and config arrangement There will be a corresponding devstack change, and once this is in I will email the packagers on the packaging implications Change-Id: Ic10b1a486094d15bfd832f0f934e6268ec323085		2013-04-24 09:18:15 +12:00
..
docbkx	ReST API: Translate the documentation to WADL	2013-04-04 19:25:24 +02:00
source	Consolidated api-paste.ini file	2013-04-24 09:18:15 +12: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