Files

Rajat Dhasmana 5eb6993cf7 Doc: Improve docs for Glance Cinder Store

This patch improves the documentation for Cinder as a backend for
Glance by including:
1. Configuration changes with the New location API
2. Details about how the optimizations are performed vs the generic path
3. Pre-conditions for the optimizations to work
4. Recommendations regarding the internal/service project while uploading volume

Change-Id: I6f3035178b2b43145b34fbeb14bac22d0b52bc27
Signed-off-by: Rajat Dhasmana <rajatdhasmana@gmail.com>

2025-12-16 00:24:12 +05:30

ext

Make docs build parallel

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

source

Doc: Improve docs for Glance Cinder Store

2025-12-16 00:24:12 +05:30

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