Files

Simon Dodsley df83770880 Update docs for Pure rebrand

Documentation-only change to reflect the rebranding of Pure Storage
to Everpure.

Change-Id: Ida981dbe4a19f0b040e7405b447e518d395cad54
Signed-off-by: Simon Dodsley <simon@purestorage.com>

2026-03-06 14:02:57 -05:00

ext

Make docs build parallel

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

source

Update docs for Pure rebrand

2026-03-06 14:02:57 -05: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