
Document has been updated to include direct connect support. The Dell EMC SC driver can be configured to point at a Storage Center directly rather than through a DSM aggregator. This addresses minimum requirements and limitation. Change-Id: I0a0095235685c8f6dc6d9cd88b27d454641da387
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