cinder/doc
Jay S. Bryant 9a4dd8ec0a Mark Huawei Fusionstorage Driver Unsupported
The Fusionstorage driver has failed to demonstrate Pyton3.7
support as was required during the Train release.  As
a result the driver is being marked unsupported and will
be removed in the 'U' release if support is not
demonstrated via 3rd Party CI.

Change-Id: Ia2ac09e43718c0064f21565157191698728a5bee
2019-09-04 09:30:05 -05:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Mark Huawei Fusionstorage Driver Unsupported 2019-09-04 09:30:05 -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 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.

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