Files

Lorin Hochstein 78de0014c6 Reference Ron Pedde's cleanup script for DevStack.

Docs now have a link to Ron Pedde's cleanup script for DevStack.

Change-Id: I2a36fbfae2ebec437091a50d17d57fef0858be74

2011-11-15 16:33:03 -05:00

build

generated files should not be in source control

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

ext

execvp: fix docs

2011-03-09 17:22:54 -05:00

source

Reference Ron Pedde's cleanup script for DevStack.

2011-11-15 16:33:03 -05: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!