Files

Jay S. Bryant 5ecb1a5e39 Correct S-Series to DS-Series systems

The new Lenovo storage systems should be branded as
DS-Series systems.  This patch corrects the documentation
accordingly.

Change-Id: I2ff8d321c97b70744037f60fee632e9d9b9dc383
(cherry picked from commit 953781e3af)
(cherry picked from commit 496ae6a3ba)

2018-06-18 09:15:04 -05:00

ext

Add Apache 2.0 license to source file

2016-12-14 02:17:04 +00:00

source

Correct S-Series to DS-Series systems

2018-06-18 09:15:04 -05:00

.gitignore

Make doc/source directory compliant with design in spec

2017-07-19 15:59:02 -05: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

README.rst

doc: verify all rst files

2017-02-14 12:36:57 +01: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: http://docs.openstack.org/developer/cinder/

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