openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Helen Walsh 05c7b77d81 PowerMax Ussuri Docs - Upgrade improvement notification 
Nofifying on the upgrade improvement from SMI-S to REST after fixing
https://bugs.launchpad.net/cinder/+bug/1867163

Change-Id: I9e273ff1f977bf77628d9122e4d02cc85740c2b9
 		2020-09-14 17:40:11 +01:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source PowerMax Ussuri Docs - Upgrade improvement notification 2020-09-14 17:40:11 +01: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