openstack/placement

History

Soren Hansen bdc9973b58 s/canonical_version/canonical_version_string/g		2011-01-08 00:02:24 +01:00
..
build	Updated sphinx layout to a two-dir layout like swift.	2010-07-24 18:06:22 -07:00
source	s/canonical_version/canonical_version_string/g	2011-01-08 00:02:24 +01:00
.gitignore	Updated sphinx layout to a two-dir layout like swift.	2010-07-24 18:06:22 -07: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!