openstack/cinder
Code Issues Proposed changes
90927c495f
cinder/doc
History
Brian Rosmaita ff96402263 docs: update new driver review page 
Prevent Ic8b301dc75f8e99efe0821f673b9da2fed1f4b7e from occurring
again.

Change-Id: I21e63160859cf17b0ced117dd4f3fd374cf0fbe5
2019-08-27 20:33:12 +00:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source docs: update new driver review page 2019-08-27 20:33:12 +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 Update docs building 2019-08-10 11:41:14 +02: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