History

Alyson Rosa f072c5cf99 Add Hitachi HNAS driver documentation

Add a .rst documentation for Hitachi HNAS Manila driver in dev docs.
Also, update the new .rst document that lists per-driver
features adding Hitachi HNAS driver details.

Change-Id: I1421d88df5ddc2a13849c9657ec90f55303065d7

2015-09-22 12:08:21 -04:00

ext

py3: use six.moves.range instead of xrange

2014-12-27 18:41:21 +08:00

source

Add Hitachi HNAS driver documentation

2015-09-22 12:08:21 -04: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!