Files
cinder/doc
LeoCampelo 6904db8605 DOC: Add cinder modules on initial configuration
Added cinder-volume and cinder-backup to be restarted as well as
cinder-api in block storage encryption initial configuration.

Closes-Bug: 1929220
Change-Id: I5b26e28478e6f7061077886304f9cebf481ff55f
2021-11-17 11:24:33 -03:00
..
2020-10-22 10:28:01 -05:00
2021-03-25 13:15:43 -04: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