Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
build
ext
source
.gitignore
Makefile
README.rst
find_autodoc_modules.sh
generate_autodoc_index.sh

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!

Something went wrong with that request. Please try again.