Files
nova/doc
Lorin Hochstein e55f2e5471 Removed autogenerated API .rst files.
Removed .rst files that are automatically generated using the nova_autodoc extension. It's not really worth keeping these in the repo since users can regenerate the files at will, and the content is also available at nova.openstack.org.

Change-Id: I6c93f9aae1994961fdca690742398a0d540d541f
2011-10-27 23:56:52 -04:00
..
2011-03-09 17:22:54 -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!