nova/doc at aee45cc4abdc0ae311cfb22a08a0fee1139b4fd0 - nova

womax/nova

Files

T

Russell Bryant aee45cc4ab Fix API extensions documentation, bug 931516.

This patch fixes the docs so that the API extensions documentation gets
included.  In passing, also update the API extensions index to include
an extension that was not listed.

Change-Id: Ia16cab2b29bbc121d940dc4ed9f033340935cde8

2012-02-15 18:52:45 -05:00

build

generated files should not be in source control

2011-06-16 11:07:36 -05:00

ext

Remove a whole bunch of unused imports

2012-01-13 13:55:38 -08:00

source

Fix API extensions documentation, bug 931516.

2012-02-15 18:52:45 -05:00

.gitignore

Remove contrib/nova.sh and other stale docs.

2011-11-15 16:32:37 -05:00

find_autodoc_modules.sh

Fix broken devref docs.

2012-01-31 16:16:24 -05: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!