openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Jay S. Bryant 85f97d86d4 [DOC FIX] Create missing index pages 
There was a mistake in the documentation migration.  The
landing pages in the admin and configuration sections should
have been moved to index.html.  That step didn't happen which
is causing it to appear that that content is missing from
the main OpenStack docs website.

This patch updates our main index page and moves the existing
landing pages to index.rst.

Change-Id: Idb96a09f748d3bbebf6eb768dfd2b758da545096
 		2017-08-10 12:04:13 -05:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source [DOC FIX] Create missing index pages 2017-08-10 12:04:13 -05:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst doc: verify all rst files 2017-02-14 12:36:57 +01: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

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