History

Lorin Hochstein 997829ea93 Remove contrib/nova.sh and other stale docs.

Removed contrib/nova.sh and any references to it in the RST docs.

removed refernece to old livecd that has nova circa 2010 on it.

.gitignore'ing some additional autogenerated doc files.

Change-Id: I7a07a58a9a6f1112fc7e486367a06f6916207784

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

build

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

2010-07-24 18:06:22 -07:00

source

Removing duplicate installation docs and adding flag file information, plus pointing to docs.openstack.org for Admin-audience docs

2011-02-21 14:27:37 -06:00

.gitignore

Remove contrib/nova.sh and other stale docs.

2011-11-15 16:32:37 -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

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!