openstack/cinder
Code Issues Proposed changes
9aca21f5ce
cinder/doc
History
Jay S. Bryant 9aca21f5ce Remove the Veritas HyperScale Driver 
The Veritas HyperScale driver was marked unsupported in
the Stein release.  It hasn't reported on a patch in
327 days.

This is outside Cinder's CI requirements and therefore
the driver is being removed.

Change-Id: I44a4dc52b2cced6dac98aa895aa3de1df0926fc5
2019-06-13 10:22:11 -05:00
..
ext Use config-table for dynamic config documentation 2019-02-26 16:50:39 -06:00
source Remove the Veritas HyperScale Driver 2019-06-13 10:22:11 -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 Cap sphinx for py2 to match global reqs 2019-05-14 15:06:27 -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