History

Sean McGinnis b6f9932f9c Include .inc files in doc8 linting We use *.inc files extensively, especially in the api-ref, but these files are not covered by default with our doc8 validation. This adds support for those files and fixes a few issues that were identified after enabling coverage. Change-Id: I807823f3cb44274c3940db55e901d434304a09f5 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>		2019-02-19 11:33:05 -06:00
..
ext	Update sphinx extension logging	2018-10-16 15:19:03 -05:00
source	Include .inc files in doc8 linting	2019-02-19 11:33:05 -06: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	Move sphinx-feature-classification to docs reqs	2018-08-30 13:37: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