cinder/doc
Avishay Traeger 030d893697 Modify Pure driver to configure PG/Pod names
Add two config options to the Pure Storage driver to allow setting the
names for replication PGs and Pods. This is beneficial in multi-backend
scenarios so that each backend can use a different PG/Pod. It also
allows for the use of existing PGs/Pods.

These options should not be modified after volumes exist on a backend.

Change-Id: Ie0dbf00fb2ecea3344e58d2b84fd4dfd6ae1daee
2018-09-04 21:54:21 +03:00
..
ext Merge "Add skip filter to config-table directive" 2018-05-18 04:23:41 +00:00
source Modify Pure driver to configure PG/Pod names 2018-09-04 21:54:21 +03: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 Use sphinxcontrib.apidoc for module docs 2018-04-05 14:36:03 -05: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