History

Angus Salkeld 08e04e6733 Add some docs for intrinsic functions.

And start the template guide.

DocImpact
Change-Id: I4dc32dfc20b464e09b78f192b6f4931ce812fd4b

2013-07-25 14:54:15 +10:00

docbkx

API support for Environments

2013-06-17 20:26:28 +10:00

source

Add some docs for intrinsic functions.

2013-07-25 14:54:15 +10: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