History

Gorka Eguileor b4d1ab9d19 docs: Write high availability devref

Adds contributor/developer reference for High Availability in Cinder.

Not only related to Active-Active, but also to Active-Passive and
concurrency in general.

Change-Id: Idfb04652f148e1f820d76d62395fe7cfcb445057

2018-08-01 14:46:42 -05:00

ext

Merge "Add skip filter to config-table directive"

2018-05-18 04:23:41 +00:00

source

docs: Write high availability devref

2018-08-01 14:46:42 -05: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

Use sphinxcontrib.apidoc for module docs

2018-04-05 14:36:03 -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