openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Chris M 99e3d3fc76 Update the HP MSA and Lenovo driver documentation 
Updated the list of supported models for the HP MSA driver.
Improved the description of the driver-specific options for the
Lenovo and HP MSA drivers.

Change-Id: Ica6ba8f2b169b54c30dbfd0e2b5ab1765a3f8a77
(cherry picked from commit a795201ef8)
 		2019-02-22 21:12:48 +00:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Update the HP MSA and Lenovo driver documentation 2019-02-22 21:12:48 +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
find_autodoc_modules.sh Fixes a small issue in find_autodoc_modules.sh 2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
requirements.txt Updated from global requirements 2018-02-01 07:06:24 +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