de953be3d4
Over the last few cycles we have removed drivers, but we did not always clean up the documentation from the openstack-manuals project. Those docs were moved over wholesale as part of the docs migration, so we ended up with them in the repo with no corresponding driver files. This removes those leftover docs and cleans up the generated documentation. Change-Id: Ib9fc4e14333548b84666e3f571e7b42fe20e0319
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