History

pangliye 88e91100cf Add Apache 2.0 license to source file

Source code should be licensed under the Apache 2.0 license.
All source files should have the licensing header.

Change-Id: I67df47560d87182265ec4fa973bddaf356829fc1

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

ext

Add Apache 2.0 license to source file

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

source

Merge "Switch default py3x to py35"

2016-12-12 17:15:52 +00: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

Update doc README and remove old Makefile

2016-07-23 18:04:04 -05: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