b0279f2080
Because the periodic_interval config option is used in several places, it is difficult to tune its value. This patch restricts the use of periodic_interval to its original purpose and introduces four new config options that may be tuned independently: * backup_driver_init_check_interval * backup_driver_status_check_interval * scheduler_driver_init_wait_time * backend_stats_polling_interval Includes release note and upgrade check. Change-Id: I498484b06cd379ad65f6f0d18aaaeb85214d4b1e Closes-bug: #1823748
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