23075e6c0b
Refactor CephFSNativeDriver as a driver class using protocol helper classes. The helper classes would handle protocol specific driver actions such as controlling access and fetching share's export locations. For now, the driver uses a protocol helper to support CephFS's native protocol. The driver can be made to support other NAS protocols later on by adding protocol helper classes. Since the driver would not just support the native protocol rename the driver's file name and its driver class as `driver` and `CephFSDriver` respectively. The driver would by default support the native protocol, and can be referred to by its previous class name and module name. DocImpact Partially-impelements: blueprint cephfs-nfs-support Change-Id: I8a33be1df4864131435b794e791cc2d651fbe741 |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| find_autodoc_modules.sh | ||
| generate_autodoc_index.sh | ||
| README.rst | ||
Manila Development Docs
Files under this directory tree are used for generating the documentation for the manila source code.
Developer documentation is built to: http://docs.openstack.org/developer/manila/
Tools
- Sphinx
-
The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.
- Graphviz
-
Some of the diagrams are generated using the
dotlanguage from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.
Building Documentation
Doc builds are performed using tox with the docs
target:
% cd ..
% tox -e docs