To maintain the alphabetic consistency of the drivers documentation page, we need to rename the Pure Storage driver file to Everpure, so that Everpure appears in the correct place in the driver list. Change-Id: I6d901dfcf4809fa23a3a0b8e950f96276d82439a Signed-off-by: Simon Dodsley <simon@purestorage.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