Files
cinder/doc
anthony gamboa ac1ee9bb8e Hitachi: Add support for Hitachi VSP One B20
Change-Id: Ica909518b9a0e4e58ad757bc9373ffc5e52e5a14
Signed-off-by: Sa Pham <saphi070@gmail.com>
(cherry picked from commit bc5591a1f9)
(cherry picked from commit 606dc17cd3)
2025-11-16 10:00:09 +07:00
..
2020-10-22 10:28:01 -05:00

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