openstack/nova
Code Issues Proposed changes
0655d2bb15
nova/doc
History
Lorin Hochstein 0655d2bb15 Document nova-tarball Jenkins job. 
Change-Id: I1034cceaa4fa3aa66e54fd082a078f802bc27baf
2011-12-02 15:43:54 -05:00
..
build generated files should not be in source control 2011-06-16 11:07:36 -05:00
ext Fix deprecation warnings 2011-11-24 10:54:21 -05:00
source Document nova-tarball Jenkins job. 2011-12-02 15:43:54 -05:00
.gitignore Remove contrib/nova.sh and other stale docs. 2011-11-15 16:32:37 -05:00
find_autodoc_modules.sh Fix to a documentation generation script. 2011-10-27 23:49:32 -04:00
generate_autodoc_index.sh Cleanups to doc process. 2010-11-07 15:14:58 -05: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

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!