History

Sean McGinnis fded726579 Remove Zadara static config option table Switch to using config-table directive. Change-Id: Ib229ece39581e1423addf05a0a91a8b0450f1737		2018-05-02 06:28:25 -05:00
..
ext	Add config table sphinx directive	2018-04-26 13:47:43 -05:00
source	Remove Zadara static config option table	2018-05-02 06:28:25 -05:00
.gitignore	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
requirements.txt	Use sphinxcontrib.apidoc for module docs	2018-04-05 14:36:03 -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