nova/doc at be3f24d7f3d62a8fbbccf78a9e4ffc8a3fba0fa4 - nova

womax/nova

Files

T

Ewan Mellor f492fced12 Bug #888730 : vmwareapi suds debug logging very verbose

Set suds log level to INFO by default, using
default_log_levels.

Change-Id: I4a1b09470aeba006112734fae9feef3d228eaced

2011-11-11 11:47:43 -08:00

build

generated files should not be in source control

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

ext

execvp: fix docs

2011-03-09 17:22:54 -05:00

source

Bug #888730 : vmwareapi suds debug logging very verbose

2011-11-11 11:47:43 -08:00

.gitignore

Updated sphinx layout to a two-dir layout like swift.

2010-07-24 18:06:22 -07: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!