History

TommyLike 8c910ccb5a [DOC BLD FIX] Add missing glossaries

This patch added missing glossaries for admin documents.

Change-Id: I7f0112de51e335cfe6522e6878b38b88074b7de7

2017-07-19 16:45:45 +08:00

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

2017-07-19 16:45:45 +08:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

find_autodoc_modules.sh

2015-01-23 14:38:44 +08:00

generate_autodoc_index.sh

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

doc: verify all rst files

2017-02-14 12:36:57 +01:00

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs