History

Gorka Eguileor 4be23ab476 Improve devref for API errors

Our current devref gives a very light description of how to return API
errors to callers.

This patch improves it to describe all mechanisms currently supported by
Cinder.

Change-Id: Ie3c39e6ec042332c813ee7c851ba993a4a58c907

2017-03-13 16:42:26 +01:00

ext

Add Apache 2.0 license to source file

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

source

Improve devref for API errors

2017-03-13 16:42:26 +01:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

doc: verify all rst files

2017-02-14 12:36:57 +01: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: http://docs.openstack.org/developer/cinder/

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