History

Anne Gentle 225fd37fb2 Adds in more documentation contributions from Citrix.		2010-12-01 20:44:43 +00:00
..
build	Add a placeholder in doc/build. Although bzr handles empty directories	2010-11-24 10:09:18 +01:00
ext	notes, and add code to enable sorted "..todo:: P[1-5] xyz" syntax	2010-11-12 09:25:01 -08:00
source	Adds in more documentation contributions from Citrix.	2010-12-01 20:44:43 +00:00
.autogenerated	Testing man page build through conf.py	2010-11-17 14:28:09 -06: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!