History

Luigi Toscano 11d74a2f08 Small doc updates: canonical URLs, rally doc, etc

- use the canonical URL on opendev.org for OpenStack projects
  whenever it is possible;
- use a reference to cinder-specs instead of the code repository;
- update few rally URLs, removing one which does not exist anymore;
- update the repository URL of the datera driver.

Change-Id: Ib14346026bd34f90aea588c35407e5e2af505866

2019-06-04 17:57:16 +02:00

ext

Use config-table for dynamic config documentation

2019-02-26 16:50:39 -06:00

source

Small doc updates: canonical URLs, rally doc, etc

2019-06-04 17:57:16 +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

Cap sphinx for py2 to match global reqs

2019-05-14 15:06:27 -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