History

Steven Hardy 459fb9472c heat docs : Update jeos building documentation

Replace references to heat-jeos with documentation describing the
use of the new heat-templates/tools/heat-jeos.sh example script

fixes bug #1171602

Change-Id: I88fd2a5667cccd79a77c4a663c782fb537279fac

2013-04-30 14:51:43 +01:00

docbkx

ReST API: Translate the documentation to WADL

2013-04-04 19:25:24 +02:00

source

heat docs : Update jeos building documentation

2013-04-30 14:51:43 +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