You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul e3c88efff7
Merge "Dell EMC Unity driver in cinder"
6 months ago
ext Make docs build parallel 2 years ago
source Merge "Dell EMC Unity driver in cinder" 6 months ago
test docs: Remove unnecessary 'blockstorage-' prefix 1 year ago
.gitignore Make doc/source directory compliant with design in spec 6 years ago
README.rst Update and replace http with https for doc links in Cinder 6 years ago
requirements.txt docs: Add whereto for testing redirect rules 1 year ago


Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to:



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.


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