openstack/cinder
Code Issues Proposed changes
e4d9a43a28
cinder/doc
History
Jay S. Bryant e4d9a43a28 Remove Oracle ZFSSA drivers 
The Oracle ZFSSA iSCSI and NFS drivers were
marked unsupported in the Train release.
Oracle has indicated that they don't plan to
continue to support the drivers so this patch
proposes their removal.

Change-Id: I78f8ecbbbf2b46a3be5d802fb58aaa998aed144a
2019-10-22 12:19:48 -05:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Remove Oracle ZFSSA drivers 2019-10-22 12:19:48 -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

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