This thing could probably do with being deprecated, but until that happens we don't want it living in the old 'cinder.api.v2' package. This is pure code motion. Change-Id: Ia3104b702839688852fc535f01b29018bdf3c9a5 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: https://docs.openstack.org/cinder/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
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