Files
cinder/doc
Jay S. Bryant cf01d7eaf3 Mark Virtuozzo Driver Unsupported
The Virtuozzo driver CI has not reported success in months
and the maintainers have not responded to any of the notes that
have been sent out.

As a result, we need to mark the drivers unsupported
for the T release.

Change-Id: Ic9c239baff19ec9cfbc1a114cdd9a899a34bedd6
2019-09-06 09:13:08 -05:00
..
2019-09-06 09:13:08 -05:00
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.

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