openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Brian Rosmaita bcec93ea14 Update policy matrix for Yoga 
This change is being made directly to stable/yoga because
the matrix is currently under revision in master (Zed
development) and is much different there.

Change-Id: Ib616995b987e695839461f20387bafc114cdb04b
 		2022-03-24 18:48:45 +00:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Update policy matrix for Yoga 2022-03-24 18:48:45 +00:00
test docs: Remove unnecessary 'blockstorage-' prefix 2022-02-20 19:06:32 +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 docs: Add whereto for testing redirect rules 2022-02-20 19:05:46 +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