e875add1e5
The list of driver docs are sorted based on their file names, but since the name was rsd* but the title was "Intel RSD...", it would show up in the list out of order. This updates the file name so the sorting works right. Change-Id: I9fda67abdf0156d1712c3c5c9013264341dd1511 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
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