History

Abhilash Divakaran a8c5b41ab4 Add share driver for Tegile IntelliFlash Arrays The Tegile driver will support the NAS shares and it will include the minimum set of features. [Supported Protocols] - CIFS, NFS The driver supports Manila driver mode (driver_handles_share_servers = False). Tegile has setup a CI. It will report as "Tegile Storage CI". DocImpact Implements: blueprint tegile-share-driver Change-Id: I2e9154454e2a34f9a0653a173846ce554026f33b		2016-03-03 01:13:54 -08:00
..
ext	py3: use six.moves.range instead of xrange	2014-12-27 18:41:21 +08:00
source	Add share driver for Tegile IntelliFlash Arrays	2016-03-03 01:13:54 -08: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!