7689e46ca5
In addition to reviewing comments, the key thing here is to get a reference to the reno doc about why you need to patch release notes directly to a stable branch or else they show up in the wrong release. Change-Id: Ice4f70d56aa81d4470ef8067d572fd8294d6cd6f
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