openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Alex O'Rourke db5c9f66e2 Update HPE 3PAR devref docs 
With the Mitaka release multiple changes have been made to the
Manila driver:
    - Access rules changes for both NFS and CIFS shares.
    - IP and user access rules changes for both NFS and CIFS shares.
    - Client version bump.
    - Deleting of file tree for nested shares.

Change-Id: I09fbaad15e18c5babdbe8a419737ffc7b23d0d7d
 		2016-04-05 17:02:47 -07:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Update HPE 3PAR devref docs 2016-04-05 17:02:47 -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

  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!