History

Xuchu Jiang 9e9c6f3899 Remove XIV part from configuration docs

Since XIV/A9000 are not supported yet, so remove XIV/A9000 part from
doc. also replace the picture with a new one without XIV/A9000 in it.

Change-Id: I928c7944981fbf166e907c9ae4038a08ccaa5c6e

2020-04-23 18:27:48 +08:00

ext

Launch driver list generation with the same python interpreter

2019-06-28 19:07:22 +02:00

source

Remove XIV part from configuration docs

2020-04-23 18:27:48 +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

Cleanup py27 support

2020-04-17 14:47:10 +02: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