History

Gorka Eguileor 3a7686fc6d Add CI_WIKI_NAME to driver's devref

The requirement to have CI_WIKI_NAME attribute in a driver is not
currently documented, which makes it harder for new drivers to know they
need to have this attribute.

This patch adds this requirement to the driver devref.

Change-Id: Ia49527c1ca15e3454e186fd6609794d87e630903

2016-08-16 13:34:13 +02:00

ext

Merge "Add driver list to doc build"

2016-07-29 02:24:22 +00:00

source

Add CI_WIKI_NAME to driver's devref

2016-08-16 13:34:13 +02: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