manila/doc
liuke2 fed9412f13 Huawei: Support reporting disk type of pool
Adding support for reporting disk type of pool in huawei manila
driver. When creating share we can specify the disk type of the
pool we want to use ssd/sas/nl_sas/mix, manila driver will report
the disk type of the pools.

Implements: blueprint huawei-pool-disktype-support
Change-Id: I1f694e8c93f79851f838d226830d9ab5344cf35a
2016-07-22 01:47:14 +00:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Huawei: Support reporting disk type of pool 2016-07-22 01:47:14 +00: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

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst
  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!