a852c46ba4
The Dell EMC ScaleIO product is being renamed to Dell EMC VxFlex OS. Update the documentation to reflect the new product name. Change-Id: Ib52e4820c80db8b2a74bd91dce473182508c7fba
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