History

Brian Rosmaita ff677d5adf doc: add rbd-iscsi-client info

Add rbd-iscsi-client-core to the list of gerrit groups maintained
by the cinder project, and add info about the rbd-iscsi-client to
the base contributor doc.

Change-Id: I37ae86a41e93d4cee652e2201adffa36cb2ff2e1

2021-02-09 22:15:25 -05:00

ext

Make docs build parallel

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

source

doc: add rbd-iscsi-client info

2021-02-09 22:15: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

Make docs build parallel

2020-10-22 10:28:01 -05: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