History

Dominic Schlegel cc3dd4a69d Add reference to LP bug in configuration doc readme

Reference umbrella LP bug in readme for easier tracking of work
if someone wants to start working on dynamically generated
configuration docs.

Change-Id: Ic22b8acd9b3f9aaea61836b52df39ab10e040fba

2019-10-10 15:18:46 +02:00

ext

Launch driver list generation with the same python interpreter

2019-06-28 19:07:22 +02:00

source

Add reference to LP bug in configuration doc readme

2019-10-10 15:18:46 +02: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

Update docs building

2019-08-10 11:41:14 +02: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