History

wangxiyuan 01357dc991 Update replication doc Change-Id: Iecb039aaf6e8d69146c7ce58c34a1953184fea7d		2016-11-10 09:05:19 +08:00
..
ext	Merge "Add driver list to doc build"	2016-07-29 02:24:22 +00:00
source	Update replication doc	2016-11-10 09:05:19 +08:00
.gitignore	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
README.rst	Update doc README and remove old Makefile	2016-07-23 18:04:04 -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	Initial fork out of Nova.	2012-05-03 10:48:26 -07: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