2a4a63effe
Fixed an issue in the contributor reference. The share replicas documentation has two references to the same driver interface and it caused a problem while generating docs, since none of them was tagged with ``:noindex:``. Change-Id: I9db0f2c07a8178895490fbcab9bfd9dcd2ccf823 Closes-Bug: #1872479
Manila Development Docs
Files under this directory tree are used for generating the documentation for the manila source code.
Developer documentation is built to: https://docs.openstack.org/manila/latest/
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
dot
language 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