History

ZhongShengping 8f7356dca6 Fix project_domain_name and user_domain_name in doc Change-Id: I192708586d89d1bf07a5e52ed1c45de6eab689a5 Closes-Bug: #1735051		2017-11-29 11:32:28 +08:00
..
ext	Add Apache 2.0 license to source file	2016-12-14 02:17:04 +00:00
source	Fix project_domain_name and user_domain_name in doc	2017-11-29 11:32:28 +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	Update and replace http with https for doc links in Cinder	2017-07-27 09:58:23 +00: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