History

Monty Taylor 50792c2ff4 Fix up coverage and jenkins test running.

The docs job wasn't working because of an un-renamed file.
Coverage wasn't running in jenkins with the xml output file.
Remove the .cache.bundle support that we're moving away from.

Change-Id: I1140baa53dee8b14ac4d1f8549425a0fdd7a8425

2012-05-21 16:46:25 -04:00

ext

Fix up coverage and jenkins test running.

2012-05-21 16:46:25 -04:00

source

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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!