Files

Andrew Bogott d69b64e27c Rename 'zone' to 'domain.'

This code was getting confusing because of the ambiguity
between dns zones and openstack availability zones.  'Domain'
seems a bit clearer than 'zone' in this context.

For blueprint public-and-private-dns.

Change-Id: I1d420be2e6f2054ee4392ce762775ece20a823b3

2012-01-18 17:54:43 -06:00

build

generated files should not be in source control

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

ext

Remove a whole bunch of unused imports

2012-01-13 13:55:38 -08:00

source

Rename 'zone' to 'domain.'

2012-01-18 17:54:43 -06:00

.gitignore

Remove contrib/nova.sh and other stale docs.

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

find_autodoc_modules.sh

Fix to a documentation generation script.

2011-10-27 23:49:32 -04:00

generate_autodoc_index.sh

Cleanups to doc process.

2010-11-07 15:14:58 -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

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!