History

Thomas Spatzier 514e9b746c Initial input for HOT template guide and spec This patch adds initial input for the HOT template guide and the HOT specification. Note that content so far is based on features implemented so far and not forward-looking in any way. Whenever new features get implemented, the guide and spec will be extended appropriately. Contributes to blueprint hot-specification Change-Id: I63d29ab0a1db6703b39f981161063d4fd9f97126		2013-08-09 11:07:34 +02:00
..
docbkx	Rename Quantum to Neutron	2013-08-06 22:08:27 -07:00
source	Initial input for HOT template guide and spec	2013-08-09 11:07:34 +02: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