Building the docs
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 nova modules.
pip install Sphinx
Some of the diagrams are generated using the
dotlanguage from Graphviz.
sudo apt-get install graphviz
Just type make:
Look in the Makefile for more targets.
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!