History

Ivan Kolodyazhny ee1ac54125 Remove deprecated query_volume_filters config option

query_volume_filters was deprecated in Pike with
Icee6c22621489f93614f4adf071329d8d2115637 and it should be safe to
remove it now.

Change-Id: Icd311db7f88c3c274d9a362eb96519e46c7e4d17

2018-11-28 15:53:44 +00:00

ext

Update sphinx extension logging

2018-10-16 15:19:03 -05:00

source

Remove deprecated query_volume_filters config option

2018-11-28 15:53:44 +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

Move sphinx-feature-classification to docs reqs

2018-08-30 13:37: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: 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