openstack/manila
Code Issues Proposed changes
1d4fb90e10
manila/doc
History
Thomas Bechtold b2d12a00d1 Fix documentation build 
manila/share/drivers/emc/plugins/registry.py was removed which leads to:

ImportError: No module named registry

while generating the documentation.

Change-Id: I3527e6bd37f56e5b1cbae0bdccd64487871ea560
2015-01-07 14:27:52 +01:00
..
ext Update manila's docs 2014-06-23 19:19:28 +03:00
source Fix documentation build 2015-01-07 14:27:52 +01:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
find_autodoc_modules.sh docs 2013-09-17 10:57:47 +03:00
generate_autodoc_index.sh modified docs 2013-09-17 12:21:17 +03:00
Makefile docs 2013-09-17 10:57:47 +03:00
README.rst docs 2013-09-17 10:57:47 +03:00

README.rst

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 manila 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!