Files

Angus Salkeld 4b578db8fb Fix all the sphinx-build warnings

except this one:
 WARNING: toctree contains reference to nonexisting document u'api/autoindex'

Change-Id: I176a75c1c3fc9603304f11f867df54d7a7b3610a

2013-08-22 12:41:31 +10:00

docbkx

Rename Quantum to Neutron

2013-08-06 22:08:27 -07:00

source

Fix all the sphinx-build warnings

2013-08-22 12:41:31 +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