History

Sahdev Zala 6931a96a14 Correct misleading template guide Ref example

Currently the template guide example of return value for reference shows an
arbitrary string, this patch repalces it with an appropriate return.

Change-Id: Iacea741456640e3cd6ce72c6a616c87ae79334bb
Closes-bug: #1226798

2013-10-21 10:14:36 -05:00

docbkx

Begin 3 chapters for Orch API Ref Manual

2013-10-09 10:04:33 -05:00

source

Correct misleading template guide Ref example

2013-10-21 10:14:36 -05: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