History

Lorin Hochstein d0d7e0bf4f Updated development environment docs.

General editing of the page on how to set up a development
environment, including:

- Documented which packages you need to install on Fedora-based
systems in order to run a development environment.
- Documented prereqs for setting up on Mac OS X
- Reorganized some sections
- Word wrapped text to 78 columns
- Removed steps to install pep8/pylint, this is now done automatically.
- MacOSX -> Mac OS X

Also, some minor edits:

Change-Id: I6f6181b3f3332fec93bc55897c7b9bdc50926908

2011-11-22 23:09:13 -05: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

Updated development environment docs.

2011-11-22 23:09:13 -05:00

.gitignore

Remove contrib/nova.sh and other stale docs.

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

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!