openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Sean McGinnis 0835b0862e
Remove Sheepdog Driver 
The Sheepdog project is no longer active and the driver was marked as
unsupported in the Train release. This completes the deprecation process
and removes the driver.

Change-Id: Ie94ae59a29473ca906c6df58a2681714049b16a1
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
 		2019-12-21 03:03:21 -06:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Remove Sheepdog Driver 2019-12-21 03:03:21 -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 Update docs building 2019-08-10 11:41:14 +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