cinder/doc
Ajitha Robert 56ee0971b3 Nimble: Add support for revert to snapshot
blueprint nimble-add-revert-to-snapshot-support

Change-Id: I63f4ae165486451b8c3da2e5d7a40a4c2a96ad4a
2020-10-12 13:04:09 -04:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Nimble: Add support for revert to snapshot 2020-10-12 13:04:09 -04: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

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