Brian Rosmaita
562cabc3ff
Update the "All About Drivers" doc page to reflect the agreement about backporting 'supported' status reached at the Victoria PTG: https://wiki.openstack.org/wiki/CinderVictoriaPTGSummary#Backporting_.27supported.27_status Change-Id: I7ce75deadc0c703331675a379b5f79743a3e2cd0
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