Files
6e9a95fe81c389c672b5150d64749b274975f7bc
nova /doc
Vishvananda Ishaya f01b0a114e merged trunk
2011年03月10日 04:42:11 +00:00
..
2011年02月21日 14:35:30 -06:00
2011年03月09日 17:22:54 -05:00
2011年03月08日 20:28:11 +00:00
2011年03月02日 16:57:56 -08:00
2010年11月07日 15:14:58 -05:00

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!