ca0786778c
Per our conversation in the Cinder weekly meeting [1] we will now switch to just running local tests against python 3.5 as that is the more recent and common 3.x version available on new distros. Other versions can still be run explicitly, but this changes the default tox run to only use 3.5. [1] http://eavesdrop.openstack.org/meetings/cinder/2016/cinder.2016-11-30-16.00.log.html#l-54 Change-Id: If2226cb229f016e36c4dfab6224d5ae353b926bb
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: http://docs.openstack.org/developer/cinder/
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