openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Gorka Eguileor a8840280e6 Update devref for OVO version bumping 
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
 		2017-03-13 17:19:30 +01:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Update devref for OVO version bumping 2017-03-13 17:19:30 +01:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst doc: verify all rst files 2017-02-14 12:36:57 +01:00
find_autodoc_modules.sh Fixes a small issue in find_autodoc_modules.sh 2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00

README.rst

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