openstack/cinder
Code Issues Proposed changes
bf3e51e5b2
cinder/doc
History
Simon Dodsley bf3e51e5b2 [Pure Storage] Add replication support for NVMe driver 
Update driver with replication support prior to initial
release of this driver in Zed.

Change-Id: I75be679ec3cabe0d93534ec3f0115875295db630
2022-09-01 10:17:39 -04:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source [Pure Storage] Add replication support for NVMe driver 2022-09-01 10:17:39 -04:00
test docs: Remove unnecessary 'blockstorage-' prefix 2022-02-20 19:06:32 +00: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 docs: Add whereto for testing redirect rules 2022-02-20 19:05:46 +00: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