History

Sofia Enriquez 662b8210aa Doc note warning about retyping an unencrypted/encrypted volume.

As we discussed at Victoria PTG[1] it would be nice to have a note
warning users to don’t try this.

[1] https://wiki.openstack.org/wiki/CinderVictoriaPTGSummary#Sizing_encrypted_volumes

Partial-Bug: #1687880
Change-Id: Ifa896c5f7336d3ce2a382ded9dcb4b3d595220db

2020-07-31 21:55:06 +00:00

ext

Launch driver list generation with the same python interpreter

2019-06-28 19:07:22 +02:00

source

Doc note warning about retyping an unencrypted/encrypted volume.

2020-07-31 21:55:06 +00: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

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