
Report SAN driver options: Added configuration options(san_ip, san_ssh_port, san_login) to report on their specific "get_driver_options" method. Abandon the target parameter: The target parameter should not be required or used. Automatic adaptation when mapping. This patch resolves the remaining issues with the target parameter and get_driver_options method in review [1]. [1]: https://review.opendev.org/c/openstack/cinder/+/767290 Change-Id: If127b75aac1ea6b25ec6473913410b1a7ec217d4
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
dot
language 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