openstack/manila

History

vponomaryov bc2d20d3bb Removed swiftclient from dependencies Swiftclient was in dependencies as artifact after port from cinder. Removed as unnecessary requirement itself and related stuff. Change-Id: I92fa249031e98a38aba721c0f3d1d7489abd562a		2014-03-03 16:30:22 +02:00
..
ext	modified docs	2013-09-17 12:21:17 +03:00
source	Removed swiftclient from dependencies	2014-03-03 16:30:22 +02: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

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!