History

zejian Zhuang 811eb1ec19 Modify a little desc to satisfy the code The method for attaching to update the status of the volume in the DB is cinder.volume.api.reserve_volume in code and the method for attaching to finalize the status of the volume and release the resourece is cinder.volume.api.attach(self, context, volume, instance_uuid, host_name, mountpoint, mode) in code. Change-Id: I1af560d5840296d28d6f005b7758b6e75faa727e		2017-08-07 16:45:22 +08:00
..
ext	Add Apache 2.0 license to source file	2016-12-14 02:17:04 +00:00
source	Modify a little desc to satisfy the code	2017-08-07 16:45:22 +08:00
.gitignore	Make doc/source directory compliant with design in spec	2017-07-19 15:59:02 -05: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	Make doc/source directory compliant with design in spec	2017-07-19 15:59:02 -05:00
README.rst	doc: verify all rst files	2017-02-14 12:36:57 +01:00

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs