Files
cinder/doc
Brian Rosmaita e429fa9740 Add cinder permissions matrix
Add documentation explaining the Identity "personas" supported
by Cinder and a permissions matrix showing the intended permissions
these personas have with respect to the cinder policy targets.

Also mark policies that need to be deprecated because they're not
fine-grained enough, and introduce new policies to replace them.

Change-Id: Id5ea2c81bedf51f3e0b4c5cb4ef569f255143a9e
2021-08-05 09:41:33 -04:00
..
2020-10-22 10:28:01 -05:00
2021-08-05 09:41:33 -04:00
2021-03-25 13:15:43 -04: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