2f0bd74604
Any new Cinder driver we add that doesn't have the "get_driver_options" method defined will break the driver list generation tools. The reason why it breaks them is because this method must be static, yet our base driver class doesn't define it as static. This patch: - Sets the base method as static to prevent new drivers from breaking the tools. - Documents the existence of this method for driver developers. - Adds get_driver_options method for drivers that are missing it. - Fix macrosan_client help message that breaks the doc building process. Closes-Bug: #1838225 Change-Id: I4797724d7b55709f0903d522b0233242b867146d |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| .gitignore | ||
| README.rst | ||
| requirements.txt | ||
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