openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Raunak Kumar 1f3fa9fb83 Mark Nimble Storage Driver supported 
Nimble Storage cinder driver had been marked as unsupported due to lack
of external CI running log. CI system is up
and running, updating it to be supported

Change-Id: I9c22c5f224a510e125b1dd82441eb1d63a8728f3
Signed-off-by: Raunak Kumar <rkumar@nimblestorage.com>
(cherry picked from commit 03d2762f88)
Signed-off-by: Raunak Kumar <rkumar@nimblestorage.com>
 		2020-04-09 15:42:47 -07:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Mark Nimble Storage Driver supported 2020-04-09 15:42:47 -07: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