History

Jenkins 458a7373d1 Merge "Fix errors preventing doc builds"		2017-07-08 00:42:54 +00:00
..
ext	Add Apache 2.0 license to source file	2016-12-14 02:17:04 +00:00
source	Merge "Fix errors preventing doc builds"	2017-07-08 00:42:54 +00:00
.gitignore	Initial fork out of Nova.	2012-05-03 10:48:26 -07: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	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