openstack/cinder

History

Tom Fifield 19f549f3a3 Update references with new Mailing List location Yesterday, openstack@lists.launchpad.org was migrated with all users to openstack@list.openstack.org. This patch updates references to the old mailing list with the new, to ensure that people encountering them don't accidentally try and join the old list! Change-Id: I7cd33f95b7baa22dbd4abb6e391ee59876998f59		2013-07-28 12:08:20 -07:00
..
ext	Fix PEP8 issues.	2012-08-28 23:28:48 +08:00
source	Update references with new Mailing List location	2013-07-28 12:08:20 -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!