History

John Griffith c3bc1aa3a6 Do not duplicate nova docs in cinder * This modifies the index.rst file to give interim info about cinder * We were regenerating the nova docs copied over which was bad! * Fixes bug 1022315 Change-Id: I46531976f3e6521cec69cc13276d328d6c2d2da3		2012-07-12 13:11:54 -06:00
..
ext	Fix up coverage and jenkins test running.	2012-05-21 16:46:25 -04:00
source	Do not duplicate nova docs in cinder	2012-07-12 13:11:54 -06:00
.gitignore	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
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

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!