History

ChangBo Guo(gcb) dd0ab650c8 Adjust doc about threading There are two ways to give other greenthread chance to run: greenthread.sleep(0) or time.sleep(0). Add the second way in threading.rst and recommend the first way for contributors. Also, PyMySQL works well with eventlet [1], and it's the default MySQL DB API driver for oslo.db now[2]. So adjust 'threading model' doc with such info. [1] https://wiki.openstack.org/wiki/PyMySQL_evaluation [2] http://docs.openstack.org/developer/oslo.db/installation.html Change-Id: I1fcf7242a6794d74da16aa5f326887cfa7257a1b		2016-10-14 13:07:47 +08:00
..
ext	Merge "Add driver list to doc build"	2016-07-29 02:24:22 +00:00
source	Adjust doc about threading	2016-10-14 13:07:47 +08: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	Update doc README and remove old Makefile	2016-07-23 18:04:04 -05: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