
Since there are three volume driver files relating to Fujitsu ETERNUS DX in cinder.volume.drivers.fujitsu, Due to the need to distinguish from the new series, I make 'eternus_dx' directory at cinder.volume.drivers.fujitsu and I move these files to the directory. Change-Id: I605698e7cf028e4fcf4896ce676250b00ecb7c86
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