History

Russell Bryant b6f6e1b7f4 Change references to RabbitMQ to include Qpid.

Update the documentation that referred to RabbitMQ to clarify that Qpid
can be used, as well.

Change-Id: I3abe32c2074bfdd3b5129ea65e9ca36cc9555c27

2012-03-06 12:32:02 -05:00

build

generated files should not be in source control

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

ext

blueprint sphinx-doc-cleanup

2012-03-01 17:03:01 -05:00

source

Change references to RabbitMQ to include Qpid.

2012-03-06 12:32:02 -05:00

.gitignore

Remove contrib/nova.sh and other stale docs.

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

find_autodoc_modules.sh

Fix broken devref docs.

2012-01-31 16:16:24 -05:00

generate_autodoc_index.sh

Fix rst formatting and cross-references

2012-03-06 08:08:25 -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!