Files

Brian Rosmaita f3a63ed6fa [docs] update gerrit group info

The cinder-core gerrit group is configured directly in project-config
to act as openstackclient/openstackSDK "service cores".  Add info to
the cinder-groups document so that we know where to look if this needs
to be changed or adjusted in the future.

Change-Id: I6b626604f9ff573ab59fd4867fdee7a0178ed7f0

2024-04-11 08:43:01 -04:00

ext

Make docs build parallel

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

source

[docs] update gerrit group info

2024-04-11 08:43:01 -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