nova/doc at ba930e035b65eaead5e7ea3525ea5afc5e6d41ad - nova

womax/nova

Files

T

Sandy Walsh 26227b79e9 Removed zones from api and distributed scheduler

There is a new Zones implementation coming that will use AMQP-to-AMQP
channels vs. the public API. This is being done for three reasons:
1. remove complications in the OpenStack API (and possibly allow EC2 Zones)
2. remove dependencies on keystone and novaclient
3. faster scheduling (fewer chances for race conditions)

Learn more here:
http://wiki.openstack.org/EssexSchedulerImprovements

Change-Id: I6fe538923dd5ae19276afac2ac3311a285fd5c99

2012-02-16 17:53:00 +00: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

Removed zones from api and distributed scheduler

2012-02-16 17:53:00 +00: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!