History

wangxiyuan 9df0bce1d0 [doc] Update doc index

1. The commit[1] added the "attach_detach_conventions_v2" doc file,
but it missed to be shown in the index.
2. The commit[2] removed "database_architecture" and "oslo-middleware"
files from doc. So we should remove them from the index as well.

[1]: Ie15233c99d91de67279b56d27a5508c5ea98d769
[2]: I145464d0d63cb5a00e0e905083c260fb6621dd89

Change-Id: I077a9d522eee06c864f1458878a794548ed93584

2017-03-22 11:28:33 +08:00

ext

Add Apache 2.0 license to source file

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

source

[doc] Update doc index

2017-03-22 11:28:33 +08:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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

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

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