openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Sean McGinnis b73df3e760 Cap sphinx for py2 to match global reqs 
Conflicts:
  doc/requirements.txt - modified the two sphinx lines to match
    the stable/queens global-requirements.txt

Change-Id: I74494d1fff366ca92ed470cdb722eb68d4fce057
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
(cherry picked from commit 7af13ef613)
(cherry picked from commit bffb7d5954)
(cherry picked from commit 3e68bf69cb)
 		2020-01-28 08:58:36 -05:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source 3PAR: Add config for NSP single path attach 2019-08-22 14:55:00 +00: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
find_autodoc_modules.sh Fixes a small issue in find_autodoc_modules.sh 2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
requirements.txt Cap sphinx for py2 to match global reqs 2020-01-28 08:58:36 -05: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