History

Sean McGinnis 9a8d738aa3 Add api-ref for mv 3.55 volume transfer Adds the api-ref information for the the 3.55 version of the volume transfer API. Change-Id: Ib91c2f7018184821437da41bc0f7b0c0b2e69f0c Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>		2018-08-17 14:53:07 +00:00
..
ext	Merge "Add skip filter to config-table directive"	2018-05-18 04:23:41 +00:00
source	Add api-ref for mv 3.55 volume transfer	2018-08-17 14:53:07 +00: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