a0eed589aa
Instead of referring to a specific network, refer to the appropriate place in the OpenStack Contributor Guide where this info can be found. Change-Id: I4331dab740b241c7f6f69489892e753cb8c36f34 |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| README.rst | ||
| requirements.txt | ||
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