History

Sandy Walsh 42b09d91f7 Docs for vm/task state transitions.

Added diagrams to RST docs that show  required vm_state / task_state
transitions for compute api operations.

(Set Sandy Walsh as author since he created the diagrams)

Change-Id: Ie6a9cd4b54321a98fea5429ee52eb781f57f31a4

2012-05-06 19:36:15 -04:00

build

generated files should not be in source control

2011-06-16 11:07:36 -05:00

ext

Get rid of all of the autodoc import errors.

2012-03-05 20:22:51 -08:00

source

Docs for vm/task state transitions.

2012-05-06 19:36:15 -04:00

.gitignore

Remove contrib/nova.sh and other stale docs.

2011-11-15 16:32:37 -05:00

find_autodoc_modules.sh

Get rid of all of the autodoc import errors.

2012-03-05 20:22:51 -08:00

generate_autodoc_index.sh

Merge "fix restructuredtext formatting in docstrings that show up in the developer guide"

2012-03-07 01:34:42 +00: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!