History

Sean McGinnis 5a7a1caa5a Move MV history under API Microversion contrib docs

The REST API Version History was being listed in the top level
TOC for the contributor guide, causing each microversion to show
up as a separate item in the table of contents. This looks a odd
and causes a lot of scrolling to get to some of the contributor
information.

This moves the version history under the API Microversions
section so all microversion information is within on section of
the guide.

Change-Id: I74232b52088a395b618e07902427889200c2fdae

2018-04-10 20:34:13 +08:00

ext

Use sphinxcontrib.apidoc for module docs

2018-04-05 14:36:03 -05:00

source

Move MV history under API Microversion contrib docs

2018-04-10 20:34:13 +08:00

.gitignore

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

requirements.txt

Use sphinxcontrib.apidoc for module docs

2018-04-05 14:36:03 -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: 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