openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Jay S. Bryant 416e60f579 Remove Nimble Storage Driver 
The Nimble Storage driver was marked
unsupported during the Train release.  Since
then, the 3rd Party CI hasn't been fixed and
there has been no sign of activity from the
vendor.  As a result the driver is being removed.

Change-Id: I6bfb5bd55ed8d2e194336ecef5d00ea8e22a4c4d
 		2019-12-19 11:59:50 -06:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Remove Nimble Storage Driver 2019-12-19 11:59:50 -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 Update docs building 2019-08-10 11:41:14 +02: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