History

Steven Hardy b7c5e698e2 docs : update local template references to heat-templates url Update references to the to-be-removed in-tree templates, so we use raw URLs to the heat-templates repo instead Change-Id: I2121cedc2bffe1760d845dd2d87d97dd2265f1e9		2013-05-07 16:56:41 +01:00
..
docbkx	ReST API: Translate the documentation to WADL	2013-04-04 19:25:24 +02:00
source	docs : update local template references to heat-templates url	2013-05-07 16:56:41 +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