openstack/manila
Code Issues Proposed changes
1dac1ac49e
manila/doc
History
Gaurang Tapase 838eae240d Add IBM GPFS Manila driver 
Adding GPFS driver back as the third party CI system
for GPFS driver is up and running.

This is a revert of commit 720ec90445

Change-Id: I86f9b7da21716346f96bae3ce30446589e4c4c37
2015-10-18 08:31:59 -04:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Add IBM GPFS Manila driver 2015-10-18 08:31:59 -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

  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!