7af13ef613
Change-Id: I74494d1fff366ca92ed470cdb722eb68d4fce057 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com> |
||
---|---|---|
.. | ||
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
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