openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Brian Rosmaita 2f5179147c doc: restrict supported Ceph versions 
As discussed at the PTG [0] and subsequent Cinder meetings [1],
set a minimum supported version of Ceph.  Also specify that we
expect the Ceph client and server versions to be in alignment.

[0] https://wiki.openstack.org/wiki/CinderWallabyPTGSummary#Ceph:_Minimum_supported_version
[1] http://eavesdrop.openstack.org/meetings/cinder/2020/cinder.2020-11-11-14.00.log.html#l-202

Change-Id: Ifd4cf76158350f60f84e3066ff41cc6ac5c2a3c3
 		2020-11-13 10:05:18 -05:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source doc: restrict supported Ceph versions 2020-11-13 10:05:18 -05: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 Make docs build parallel 2020-10-22 10:28:01 -05: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