
The Storpool Driver 3rd Party CI hasn't reported in over 60 days. This does not meet the requirements for Cinder's 3rd Party CI requirements. As a result the driver is being marked unsupported in the Train release and should be removed in the 'U' release if the problems are not resolved. Change-Id: Ia385485d41617e1be5c6b60705ee39e39832a945
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
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