401c8d982e
Reuse code of old LVM share driver. LVM Driver is 1st party Manila driver with NFS and CIFS support and no share server support. LVM Driver doesn't rely on Neutron, Nova, or Cinder. As such, it is ideal for testing purposes and, after a period of maturation, it should be useful in production environments. Move generic driver's helpers to manila/share/drivers/helpers.py and reuse them in LVM driver. Implement 'ro' access, user access, extend_share function for LVM driver. Implements bp lvm-driver Change-Id: Ia46c51ed400dbb0f1d87a758fb165ca711ed3d7c
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!