cinder/doc
Alberto Planas 72bc39c946 Adds openSUSE support for developer documentation
Add information for openSUSE as developer platform.

Change-Id: I3d5429f78b06cd38b10756570acea96fb23ed021
2014-09-29 17:25:10 +02:00
..
ext Remove definition of Python Source Code Encodings 2014-07-10 17:33:01 +09:00
source Adds openSUSE support for developer documentation 2014-09-29 17:25:10 +02:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
find_autodoc_modules.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
generate_autodoc_index.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
Makefile Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst Initial fork out of Nova. 2012-05-03 10:48:26 -07:00

Building the docs

Dependencies

Sphinx

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 cinder modules.

pip install Sphinx
Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

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!