a8d73a93c5
The Cinder team has some code review policies that are generally known but not documented anywhere. This patch provides a place for us to document those reiview practices that may not be known to everyone. I have started by documenting the new process proposed at the Dublin PTG for targeting milestones. I also add documentation to formalize the fact that we should not merge vendor patches without their CI passing on the patch. Change-Id: Ie3bb23dcb6299f15ae69e12095c1aa9640565c33
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