a8c5b41ab4
The Tegile driver will support the NAS shares and it will include the minimum set of features. [Supported Protocols] - CIFS, NFS The driver supports Manila driver mode (driver_handles_share_servers = False). Tegile has setup a CI. It will report as "Tegile Storage CI". DocImpact Implements: blueprint tegile-share-driver Change-Id: I2e9154454e2a34f9a0653a173846ce554026f33b |
||
---|---|---|
.. | ||
ext | ||
source | ||
.gitignore | ||
find_autodoc_modules.sh | ||
generate_autodoc_index.sh | ||
Makefile | ||
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!