History

Monty Taylor efdd9c8c80 Update common setup code to latest. This gets us up to date with common/setup.py and replaces custom nova autodoc generation with the port of that code found in common. Change-Id: I2a1c5d2c0fdcf40dbea50cc123b537adb068cdc2		2012-07-07 16:32:19 -05:00
..
build	generated files should not be in source control	2011-06-16 11:07:36 -05:00
ext	Update common setup code to latest.	2012-07-07 16:32:19 -05:00
source	Update common setup code to latest.	2012-07-07 16:32:19 -05:00
.gitignore	Remove contrib/nova.sh and other stale docs.	2011-11-15 16:32:37 -05:00
Makefile	Since we're autodocumenting from a sphinx ext, we can scrap it in Makefile.	2010-11-07 18:18:04 -05:00
README.rst	Fix rst formatting and cross-references	2012-03-06 08:08:25 -05: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 nova 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!