cinder/doc
Jon Bernard 1a9518119c RBD: add support for revert-to-snapshot
We note here that although this operation is implemented in the
Ceph backend, the Ceph docs indicate that it is inefficient and the
preferred method of returning to a known previous state is to clone
from a snapshot.  However, this is properly a backend operation, and
it does not make sense to try to do it better in the driver than it
can be done on the backend.

Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Implements: bp rbd-revert-to-snapshot
Change-Id: If8a5eb3a03e18f9043ff29f7648234c9b46376a0
2020-04-07 10:06:54 -04:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source RBD: add support for revert-to-snapshot 2020-04-07 10:06:54 -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 Drop requirements for unsupported python versions 2020-01-02 14:55:25 -06: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