cinder/doc
Veronica Musso 22d0c38bb9 Update Cinder dev doc
Removing mention of adding your name and email to Author files in
Cinder dev doc.

Change-Id: I5b723dd9ff1153096852a4c1c6a7b59bf0d04d3c
Closes-Bug: #1309581
2014-04-16 08:16:30 -03:00
..
ext Use built-in print() instead of print statement 2013-09-18 08:44:28 -07:00
source Update Cinder dev doc 2014-04-16 08:16:30 -03: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!