9
You'll need sphinx (the python one) and if you are
10
using the virtualenv you'll need to install it in the virtualenv
11
specifically so that it can load the nova modules.
18
Some of the diagrams are generated using the ``dot`` language
23
sudo apt-get install graphviz
25
.. _Sphinx: http://sphinx.pocoo.org
27
.. _Graphviz: http://www.graphviz.org/
37
Look in the Makefile for more targets.
43
1. Generate the code.rst file so that Sphinx will pull in our docstrings::
45
% ./generate_autodoc_index.sh > source/code.rst
47
2. Run `sphinx_build`::
49
% sphinx-build -b html source build/html
52
The docs have been built
53
========================
55
Check out the `build` directory to find them. Yay!
added
removed
doc/README.rst
