History

Eric Harney c64a9da338 Fix sphinx errors related to missing paths/modules

Remove/update paths/modules in docs that are no
longer valid.

Change-Id: I085d6d804927ab2d559bd8e9d0a95de84ddef2a0

2017-01-04 14:26:19 -05:00

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

2017-01-04 14:26:19 -05: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

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