openstack/cinder
Code Issues Proposed changes
7c8cd0ba05
cinder/doc
History
Jay S. Bryant 38d3a7d87b Mark Veritas CNFS Driver Unsupported 
The Veritas CNFS driver CI stopped reporting
a long time ago and there has been no activity
from the vendor.

As a result this patch marks the driver
unsupported.  It will be removed in the 'V'
release if there is no change in support.

Change-Id: I541cebdabc0799273f1bc241c4b30948939f2f5d
2020-01-13 20:46:45 -06:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Mark Veritas CNFS Driver Unsupported 2020-01-13 20:46:45 -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 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