History

Brian Rosmaita fce3e1a6e0 Update release cycle tasks

Some due dates have changed, and add info about the 'release-notes'
in the deliverables .yaml files.

Change-Id: I041bf0f9f18788c0dc7f2d3ccb00701672cf8ffb

2021-11-19 12:06:57 -05:00

ext

Make docs build parallel

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

source

Update release cycle tasks

2021-11-19 12:06:57 -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

Use os-brick 4.3.0

2021-03-25 13:15:43 -04: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