553e86baa2
I found a file that should have come over with the migration of the configuration documents. This patch adds the missing table. It also updates an old link to the cinder.conf.sample file that used to be checked into the tree to use the dynamically generated file. Change-Id: I510432fb27a1a32f3c554912e2f578efdd95cfd8
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: http://docs.openstack.org/developer/cinder/
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