History

Mark Sturdevant 7c822401f6 HP 3PAR Add version checking and logging Check for the minimum supported hp3parclient. The older ones are not supported and this minimum fixes a bug. Log the hp3parclient, 3PAR WSAPI and driver code versions as requested by support. Change-Id: I32cff4c5d9f71a9d110a9b08f73e064c178c796a Closes-Bug: #1463552		2015-06-15 11:13:10 -07:00
..
ext	py3: use six.moves.range instead of xrange	2014-12-27 18:41:21 +08:00
source	HP 3PAR Add version checking and logging	2015-06-15 11:13:10 -07: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!