cinder/doc
Simon Dodsley dfbcca0d8b Add Pure Storage NVMe-RoCE driver
Add driver to support NVMe over RoCE for the Pure Storage FlashArray.

Depends-On: I278dd4a6fcbdc1bc477e998eabe07edf81dabd21
Change-Id: Ie964990e0d377aef94d970818338a239919bcc8c
Implements: blueprint purestorage-nvme-driver-for-flasharray
2022-07-29 09:34:06 -04:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Add Pure Storage NVMe-RoCE driver 2022-07-29 09:34:06 -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

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