History

Russell Bryant d0eedcdd22 Fix API extensions documentation, bug 931516.

This patch fixes the docs so that the API extensions documentation gets
included.  In passing, also update the API extensions index to include
an extension that was not listed.

Change-Id: Ia16cab2b29bbc121d940dc4ed9f033340935cde8

2012-02-15 18:52:45 -05:00

build

Updated sphinx layout to a two-dir layout like swift.

2010-07-24 18:06:22 -07:00

source

Fix API extensions documentation, bug 931516.

2012-02-15 18:52:45 -05:00

.gitignore

Remove contrib/nova.sh and other stale docs.

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

README.rst

Merge lp:~termie/nova/trunkdoc (via patch, since bzr though it was already merged)

2010-11-07 14:51:40 -05:00

README.rst

Building the docs

It is really easy. 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.

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!