9dd5232ea5
In package building process, there might be build environments becoming more popular without Python 2.x being installed, with other words /usr/bin/python does not exist. The existing script uses a shebang of "env python", which works fine inside a virtualenv but not outside. The easy solution is to just call the script with the same python interpreter we're being called with. Change-Id: Id91996545f7f75c1c62cea34e240b9655b8ff3af
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