openstack/nova
Code Issues Proposed changes
913d078469
nova/doc
History
Todd Willey 913d078469 quieter doc building (less warnings).
2010-11-07 14:58:02 -05:00
..
build Added a few more missing files to MANIFEST.in and added some placeholder 2010-07-27 21:52:01 -07:00
ext add in custom todo, and custom css 2010-11-05 12:49:42 -07:00
source quieter doc building (less warnings). 2010-11-07 14:58:02 -05:00
.gitignore Updated sphinx layout to a two-dir layout like swift. 2010-07-24 18:06:22 -07:00
find_autodoc_modules.sh quieter doc building (less warnings). 2010-11-07 14:58:02 -05:00
generate_autodoc_index.sh quieter doc building (less warnings). 2010-11-07 14:58:02 -05:00
Makefile quieter doc building (less warnings). 2010-11-07 14:58:02 -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!