History

Dominic Schlegel 0f082b0cb7 Remove unreferenced document table and image files As those files are not referenced anywhere within this repository we can get rid of them. This is a follow up of the findings during the review of https://review.opendev.org/#/c/687491/ Change-Id: Ic2d5e52a7c8b8cf2f230f6a2b440d29ebb6de3f5		2019-10-10 16:51:09 +02:00
..
ext	Launch driver list generation with the same python interpreter	2019-06-28 19:07:22 +02:00
source	Remove unreferenced document table and image files	2019-10-10 16:51:09 +02: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	Update docs building	2019-08-10 11:41:14 +02: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