openstack/cinder
Code Issues Proposed changes
3ee18e5f6a
cinder/doc
History
Shatadru Bandyopadhyay 3ee18e5f6a doc: fixes typo in multi backend configration doc 
changed backend_default to backend_defaults

Change-Id: Id2d66ec7fbe254a5d58ada2aa39cdf86de6f1f43
Closes-Bug: 1856859
2019-12-18 21:16:32 +05:30
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source doc: fixes typo in multi backend configration doc 2019-12-18 21:16:32 +05:30
.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 Update docs building 2019-08-10 11:41:14 +02: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