History

Sean McGinnis 2fa49bbbe2 Remove docs for --allow-multiattach This flag has been deprecated since Queens and is beinge removed from python-cinderclient. We should only now state the supported multiattach configuration using volume type extra specs. Change-Id: Ic0156dc5abb15a04ba5c6e0900177aa6c22d7940 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>		2019-04-18 12:19:25 -05:00
..
ext	Use config-table for dynamic config documentation	2019-02-26 16:50:39 -06:00
source	Remove docs for --allow-multiattach	2019-04-18 12:19:25 -05: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	Move sphinx-feature-classification to docs reqs	2018-08-30 13:37:04 -05: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