openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Brian Rosmaita 95c20b99c3 Revert "Remove ProphetStor Flexvisor Driver" 
The driver removal policy was relaxed in January 2020 [0] to allow
unsupported drivers to remain in-tree at the discretion of the Cinder
project team.  Thus this driver, which was marked unsupported in
Train and removed early in Ussuri, is being restored.  It remains
deprecated and subject to removal should its presence affect the
gate adversely.

[0] https://docs.openstack.org/cinder/latest/drivers-all-about.html#driver-removal
git

This reverts commit cbda94022c.

Conflicts:
  cinder/volume/drivers/prophetstor/dplcommon.py
  - revised order of imports

Change-Id: I1af2b85f97ce64e4e667a844f7e2bac94b8ac7a8
Partially-implements: bp restore-unsupported-drivers
 		2020-04-06 08:52:14 -04:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Revert "Remove ProphetStor Flexvisor Driver" 2020-04-06 08:52:14 -04: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 Drop requirements for unsupported python versions 2020-01-02 14:55:25 -06: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