History

Rajat Dhasmana 8eaa1a5e68 Correct multiattach documentation After change[1], there is only one way to create a multiattach volume and that is using a multiattach volume type. Our documentation mentions there are 2 ways to create multiattach volumes which is incorrect, this patch corrects the same. [1] https://review.opendev.org/c/openstack/cinder/+/874865 Change-Id: Icaa2f60c5af8869e481bd3b90aa4cf219f843eef		2023-05-09 16:52:06 +00:00
..
ext	Make docs build parallel	2020-10-22 10:28:01 -05:00
source	Correct multiattach documentation	2023-05-09 16:52:06 +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

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs