Files

Stephen Finucane 6b3b9ccdeb trivial: Remove trailing spaces, mixed tabs/spaces

We also remove "empty" JSON bodies since they don't show anything useful
and can't be linted.

PS: Don't worry about us changing release notes: reno has handled this
for some time and only cares about when the note was added (or deleted),
not when it was changed.

Change-Id: I869f6e4a47af3ef3168978bdb03f387d5bb2947f
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

2024-09-18 13:52:28 +01:00

ext

Make docs build parallel

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

source

trivial: Remove trailing spaces, mixed tabs/spaces

2024-09-18 13:52:28 +01: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