History

Xing Yang c91f27f4e1 Manage and unmanage snapshot Add APIs to support manage and unmanage share snapshots. Also add support in the Generic driver. This only supports for DHSS=False driver mode. Add provider_location column to the share_snapshots table to save data used to identify the snapshot on the backend. Also need to bump microversion. APIImpact DocImpact Change-Id: I87a066173c85d969607d132accd9f0e9bd49c235 Implements: blueprint manage-unmanage-snapshot		2016-02-18 04:09:05 -05:00
..
ext	py3: use six.moves.range instead of xrange	2014-12-27 18:41:21 +08:00
source	Manage and unmanage snapshot	2016-02-18 04:09:05 -05:00
.gitignore	Initialize from cinder	2013-08-08 10:34:06 -04:00
Makefile	docs	2013-09-17 10:57:47 +03:00
README.rst	docs	2013-09-17 10:57:47 +03: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

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!