History

Gorka Eguileor 893eb180f1 Small change to microversion header on devref

The way the API microversion dev ref is rendered can lead to a confusion
on the required header, as it reads:

 volume: OpenStack-API-Version: volume 3.0

This patch makes a small change so that the actual header is standing on
its own.

TrivialFix

Change-Id: Ibbc90ef55e2b3bfe746ee9fcfda686491469a5d2

2017-01-26 11:56:49 +01:00

ext

Add Apache 2.0 license to source file

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

source

Small change to microversion header on devref

2017-01-26 11:56:49 +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

Update doc README and remove old Makefile

2016-07-23 18:04: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: 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