History

Steven Hardy d5d890a00f Purge ubuntu getting started guide of old info The ubuntu getting started guide has not been maintained, and most likely no longer works. We should point people to Debian/Ubuntu docs when they exist, or the devstack getting started guide. Change-Id: I27a12b5366739ffcad459706c0712882b89abd2f Closes-Bug: #1182428		2013-10-01 08:20:22 +01:00
..
docbkx	Replace OpenStack LLC with OpenStack Foundation	2013-09-20 02:43:12 +08:00
source	Purge ubuntu getting started guide of old info	2013-10-01 08:20:22 +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