Files

Muhammad Mubeen Khan ea866739f4 Doc: IBM Spectrum Virtualize family [SVf] Volume driver document correction

Corrected the hyperlink for 'IBM Documentation' by adding https:// at the beginning of hyperlink to make sure documentation link navigates to page https://www.ibm.com/docs/en.
Also, removed the word 'IBM' from family product and added Storwize which was missing.

Change-Id: Iac8f0d446f5dee6ee42ac603791b21da7a00dae5

2023-01-10 13:39:22 +00:00

ext

Make docs build parallel

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

source

Doc: IBM Spectrum Virtualize family [SVf] Volume driver document correction

2023-01-10 13:39:22 +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

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