openstack/manila

History

Mark Sturdevant 4b12f9c8e7 HP 3PAR extra-spec prefix needs to be hp3par The HP 3PAR share type extra-spec prefix needs to be "hp3par". The decision to go with "hpe" was premature and has been reversed. It needs to be "hp3par" to be in sync with Cinder. Change-Id: I616832c71d1797fc00da0d9e42c35c315381b6d9 Depends-On: I26dd32b1de8cceeaa6dc674092efec683df71889 Closes-bug: #1488662		2015-09-02 19:51:39 +00:00
..
ext	py3: use six.moves.range instead of xrange	2014-12-27 18:41:21 +08:00
source	HP 3PAR extra-spec prefix needs to be hp3par	2015-09-02 19:51:39 +00: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!