History

John Garbutt aa87498199 Removes the xensm driver This code does not work, and is slowly being replaced by alternative XenServer specific drivers. Fixes LP bug #1077011 Change-Id: I1af92ecdbb49a57a0ff4c05a70d77bcb69958cb2		2012-11-20 14:47:14 +00:00
..
ext	Fix PEP8 issues.	2012-08-28 23:28:48 +08:00
source	Removes the xensm driver	2012-11-20 14:47:14 +00: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!