History

Fix Xtremio driver configuration ordering

Driver was incorrectly moved to a different place in the TOC since it
still had the non-Dell naming. This moves it back and renames it to
hopefully prevent this kind of mistake from happening again.

Change-Id: I797c7cf86dcb2598c04a3697093c458e64d84ae1
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

2019-01-07 14:24:33 -06:00

ext

Update sphinx extension logging

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

source

Fix Xtremio driver configuration ordering

2019-01-07 14:24:33 -06: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

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