openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Ivan Pchelintsev 25ed65f1fa Remove VxFlex OS credentials from connection_properties 
VxFlex OS password is not stored in block_device_mapping table. Instead of this
passwords are stored in separate file and are retrieved during each attach/detach
operation.

Closes-Bug: #1823200
Change-Id: I3f6bfe360491c295bdb81008c31ad2d4e3305736
 		2020-06-03 18:33:00 -04:00
..
ext Use config-table for dynamic config documentation 2019-02-26 16:50:39 -06:00
source Remove VxFlex OS credentials from connection_properties 2020-06-03 18:33:00 -04:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt Cap sphinx for py2 to match global reqs 2020-01-23 16:10:24 -06:00

README.rst

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