History

Jay S. Bryant 4559c8ccca [DOC] Remove duplicate build of module index

It was noticed that we had the module index built on both
the main landing page as well as on the contributor/api/index.html
page.  This patch removes the module index from the main landing
page.

Change-Id: If10286046de36da3368c8c274e6c8fd5de353fa0

2017-09-12 16:19:42 -05:00

ext

Add Apache 2.0 license to source file

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

source

[DOC] Remove duplicate build of module index

2017-09-12 16:19:42 -05:00

.gitignore

Make doc/source directory compliant with design in spec

2017-07-19 15:59:02 -05: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

Make doc/source directory compliant with design in spec

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

README.rst

Update and replace http with https for doc links in Cinder

2017-07-27 09:58:23 +00: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: https://docs.openstack.org/cinder/latest/

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