History

John Griffith cb3fb51be8 Add db client packages to dev env setup doc.

Dev env setup doc hasn't been updated in a while and
needed the addition of the mysql and psql packages.

Tested this on a clean install and it looks like
the addition of these two pkgs should get us up to
date.

Change-Id: I66011478064bd8fb85bfaf56e8b14232226e0efc

2013-05-06 10:18:48 -06:00

ext

Fix PEP8 issues.

2012-08-28 23:28:48 +08:00

source

Add db client packages to dev env setup doc.

2013-05-06 10:18:48 -06:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

find_autodoc_modules.sh

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

generate_autodoc_index.sh

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

Makefile

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

Building the docs

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.

pip install Sphinx

Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!