a8840280e6
Our devref is not explicit enough on when a versioned object change requires a version bump and this is creating confusion in developers and reviewers. This patch adds explicitly when bumps are required, when not, and how to automatically check if it's required or not. Change-Id: I4dd21c30b3a844ff47b3b3370ecd51d3e50655d5
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: http://docs.openstack.org/developer/cinder/
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