History

Lorin Hochstein 1d5fd3d98c Updated RST docs: bzr/launchpad -> git/github Change-Id: I3534cc380cb9170ff96f710250b470dc284e5680		2011-10-17 22:10:02 -04: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	Updated RST docs: bzr/launchpad -> git/github	2011-10-17 22:10:02 -04:00
.gitignore	Updated sphinx layout to a two-dir layout like swift.	2010-07-24 18:06:22 -07: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
find_autodoc_modules.sh	quieter doc building (less warnings).	2010-11-07 14:58:02 -05:00
generate_autodoc_index.sh	Cleanups to doc process.	2010-11-07 15:14:58 -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!