History

Gorka Eguileor d2182aac3a Docs: Improve contributor's release notes

Add some specifics on the contributor's release notes page regarding bug
references and driver patches.

Change-Id: I39b818bd560bf57dc7e52583061b6ceb87686f45

2020-08-06 13:47:31 +02:00

ext

Launch driver list generation with the same python interpreter

2019-06-28 19:07:22 +02:00

source

Docs: Improve contributor's release notes

2020-08-06 13:47:31 +02: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

Switch to newer openstackdocstheme and reno versions

2020-05-27 12:28:24 +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