History

Sean McGinnis 87379d326e Remove exec flag from doc files

A couple files were checked in with the executable flag set. This
removes exec.

Change-Id: I3188bc31f1292b28f981e89cad5b16db5d38486f

2018-04-05 14:06:26 -05:00

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

2018-04-05 14:06:26 -05:00

.gitignore

2017-07-19 15:59:02 -05:00

find_autodoc_modules.sh

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

generate_autodoc_index.sh

2017-07-19 15:59:02 -05:00

README.rst

2017-07-27 09:58:23 +00:00

requirements.txt

2018-03-15 06:48:48 +00: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