openstack/placement
Code Issues Proposed changes
68b25c2a83
placement/doc
History
annegentle ee7213b705 Adds extension documentation for some but not all extensions 
Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
..
build Updated sphinx layout to a two-dir layout like swift. 2010-07-24 18:06:22 -07:00
source Adds extension documentation for some but not all extensions 2011-12-02 13:02:06 -06:00
.gitignore Remove contrib/nova.sh and other stale docs. 2011-11-15 16:32:37 -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

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst

  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!