openstack/cinder
Code Issues Proposed changes
00519aef92
cinder/doc
History
Brian Rosmaita 00519aef92 Remove HPE Lefthand Driver 
The HPE Lefthand Driver was marked unsupported and was deprecated
during the Train release by commit 27c0ca65a2.
The product line has gone EOL and the LeftHand OS no longer receives
upgrades, so remove the driver.

Change-Id: Ibdd79282777b705c04b33073112f7280f45c2b2f
2020-04-01 14:50:38 -04:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Remove HPE Lefthand Driver 2020-04-01 14:50:38 -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