openstack/cinder
Code Issues Proposed changes
a499372ca5
cinder/doc
History
Brian Rosmaita cfa3329fcb Correct "Clean up policy matrix for Xena release" 
The volume_extension:hosts policy, being admin-only, was not touched
in Xena.  Hence, it wasn't deprecated and the new policies were not
introduced.  Correct the matrix to reflect this.

Change-Id: I1c68fc603f1d2fdc7a9c04b5c42e8e6e89c69fc6
2021-09-16 10:29:11 -04:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Correct "Clean up policy matrix for Xena release" 2021-09-16 10:29:11 -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 Use os-brick 4.3.0 2021-03-25 13:15:43 -04: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