openstack/cinder
Code Issues Proposed changes
06c4ab01b8
cinder/doc
History
Thomas Goirand 61b6714946 Fix doc: s/cgroup-bin/cgroup-tools/ 
The cgroup-bin was a transition package to cgroup-tools in Debian
Buster, in Sid/Testing it was removed recently. As a consequence,
we must advise our users to install cgroup-tools rather than
cgroup-bin.

Change-Id: I9291f84dcd6b6ed1a6c45416e272ac63ce02b6e9
2020-05-01 13:25:11 +02:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Fix doc: s/cgroup-bin/cgroup-tools/ 2020-05-01 13:25:11 +02: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