History

Tovin Seven 12b4432cb6 Trivial: Update pypi url to new url Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: Ib3d1b29dbfe20afeab4756673e772b597fd63fdc		2018-04-20 16:49:22 +07:00
..
ext	Use sphinxcontrib.apidoc for module docs	2018-04-05 14:36:03 -05:00
source	Trivial: Update pypi url to new url	2018-04-20 16:49:22 +07: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