History

Dominic Schlegel 7caea1c0c2 Remove warning that docs are auto generated

The warning in question has been generated by the obsolete tool
autogenerate-config-doc which has been removed 2 years ago by
https://review.opendev.org/#/c/509401/


Change-Id: Ib00514ae82a0e942d14fb604aec3983fa74bff38

2019-10-10 13:21:10 +00:00

ext

Launch driver list generation with the same python interpreter

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

source

Remove warning that docs are auto generated

2019-10-10 13:21:10 +00: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