History

Jay S. Bryant bad9d9157c [DOC] Update index page for Install tutorial

The index page for our install tutorial should point
back to the top level OpenStack installation tutorial
to give the user information on how to set up the base
OpenStack environment before starting installation.

This patch adds the link and notes that the setup in
there is a prerequisite to executing the Cinder Install
Tutorial.

Change-Id: I42418b30b3978bac24a856c22342ce5db3e42282

2017-09-19 13:32:52 -05:00

ext

Add Apache 2.0 license to source file

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

source

[DOC] Update index page for Install tutorial

2017-09-19 13:32:52 -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