History

Sean McGinnis cef38b5e84 Add upgrade checker for backup driver path

This adds an upgrade check to make sure the backup_driver setting is
using the full path to the driver and not just specifying the module.
Use of the module path for this setting was deprecated several releases
ago and removed in Stein.

Change-Id: I6b9722ab0d7a8bdf808bd937b0c237e3715ccaab
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

2019-04-03 11:58:09 +00:00

ext

Use config-table for dynamic config documentation

2019-02-26 16:50:39 -06:00

source

Add upgrade checker for backup driver path

2019-04-03 11:58:09 +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

Move sphinx-feature-classification to docs reqs

2018-08-30 13:37:04 -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