Files

Takashi Kajinami 69680d4d08 Replace obsolete PCRE packages

pcre3 was removed from recent debian-based releases (eg. Trixie[1]),
while RHEL10/CentOS Stream 10 no longer ships pcre in favor of pcre2.

Use the latest whereto library release (0.5.0) which uses pcre2
instead.

[1] https://lists.debian.org/debian-devel/2021/11/msg00176.html

Depends-on: https://review.opendev.org/c/openstack/requirements/+/971428
Change-Id: I12a23a4c05a5b02564c0724dd052c2ab508b8191
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>

2026-01-20 23:03:08 +09:00

ext

Make docs build parallel

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

source

Merge "VAST Data Volume Driver"

2026-01-13 03:43:49 +00: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

Replace obsolete PCRE packages

2026-01-20 23:03:08 +09: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