nova/doc at e8bc00eff22288c31a8ea36bf1faaa362d60d3cd - nova

womax/nova

Files

T

Lorin Hochstein d304d828d0 Added docs on MySQL queries blocking main thread.

Added to the RST docs to describe how queries to MySQL will block a nova
service.

Change-Id: I4ae209e2827978cc5469162d386197f2e46b342d

2012-03-03 20:56:24 -05:00

build

generated files should not be in source control

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

ext

blueprint sphinx-doc-cleanup

2012-03-01 17:03:01 -05:00

source

Added docs on MySQL queries blocking main thread.

2012-03-03 20:56:24 -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

blueprint sphinx-doc-cleanup

2012-03-01 17:03:01 -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!