History

Sean McGinnis e75be5d905 Switch to use key_manager.backend

Castellan commit 8980bf7da55dd084ad84c84534fe937f0d43b9c0 deprecated the
api_class option in favor of the new backend option. This causes doc build
failures in Cinder due to us treating warnings as errors.

This changes over to use backend (the library will still recognize api_class
as an option) and removed some of the key manager code deprecated in Newton.

Depends-on: I112f7a4654a65c3291526b408838d7b1c175b069
Closes-bug: #1718468
Change-Id: I8d3638a69f4efcc52053269c51c01667fb810172

2017-09-20 12:17:14 -05:00

ext

Add Apache 2.0 license to source file

2016-12-14 02:17:04 +00:00

source

Switch to use key_manager.backend

2017-09-20 12:17:14 -05:00

.gitignore

Make doc/source directory compliant with design in spec

2017-07-19 15:59:02 -05:00

find_autodoc_modules.sh

Fixes a small issue in find_autodoc_modules.sh

2015-01-23 14:38:44 +08:00

generate_autodoc_index.sh

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

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