History

whoami-rajat bf21cfff43 doc: Change variable name DEFAULT_API_VERSION to _MIN_API_VERSION

The DEFAULT_API_VERSION variable doesn't exist in the specified
file.
As stated in [1], _MIN_API_VERSION is used as the default api
version if no version is specified.

[1] https://github.com/openstack/cinder/blob/master/cinder/api/openstack/api_version_request.py#L133-L136

Change-Id: I6ecd0b2993c00c3abea98afc5be63bc8dc78624e

2018-11-13 12:45:10 +05:30

ext

Update sphinx extension logging

2018-10-16 15:19:03 -05:00

source

doc: Change variable name DEFAULT_API_VERSION to _MIN_API_VERSION

2018-11-13 12:45:10 +05:30

.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

Move sphinx-feature-classification to docs reqs

2018-08-30 13:37:04 -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