openstack/cinder
Code Issues Proposed changes
285fbc6447
cinder/doc
History
Jay S. Bryant 285fbc6447 Remove the CoprHD driver 
The CoprHD driver was marked unsupported
in Rocky and the vendor has indicated that
the driver is deprecated.  Given the feedback
I am removing the driver.

Change-Id: I978315402edeb0c5dd6aee28315973fa502b0e20
2018-08-09 21:34:25 +00:00
..
ext Merge "Add skip filter to config-table directive" 2018-05-18 04:23:41 +00:00
source Remove the CoprHD driver 2018-08-09 21:34:25 +00: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 Use sphinxcontrib.apidoc for module docs 2018-04-05 14:36:03 -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