History

Sean McGinnis e732506605 Clean up doc configuration

Remove some stale settings and get rid of setting version and
release. Those settings are now taken care of by openstackdocstheme
and do not need to be explicitly set, and since docs jobs no
longer install the project in order to generate docs, we are not
able to load those values from the python modules anyway.

Change-Id: I1a9a48538ca5c5e22e02f34c837e8fc783aeb2e9

2018-04-05 14:37:48 -05:00

ext

Use sphinxcontrib.apidoc for module docs

2018-04-05 14:36:03 -05:00

source

Clean up doc configuration

2018-04-05 14:37:48 -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

README.rst

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to: https://docs.openstack.org/cinder/latest/

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.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs