f26c6cac5c
Last year, code changes were done to add Peer Persistence support for the HPE 3PAR backend. Change details: I2d0342adace69314bd159d3d6415a87ff29db562 The same code changes work for the newer HPE Primera backend. This patch updates the documentation. Change-Id: I0df55ee5548caa6f37522253ffa6f081000c78bb
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
dotlanguage 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