Files

Brian Rosmaita b45379de37 Add statement about CI for backports

Back in February, the cinder project announced a policy that we'd
like to see CI results documented on driver backports:
http://lists.openstack.org/pipermail/openstack-discuss/2022-February/027021.html

Bring this info into the contributor documentation.

Change-Id: Ide112de44887c031cf160e30dbdfe083c1998bda

2022-04-20 12:50:24 -04:00

ext

Make docs build parallel

2020-10-22 10:28:01 -05:00

source

Add statement about CI for backports

2022-04-20 12:50:24 -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