openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Monty Taylor bed562d255
Remove vestigate HUDSON_PUBLISH_DOCS reference 
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.

Change-Id: I37cff23175d111371bd7bcf3b53ff7e47ca80cb5
 		2017-09-02 08:41:34 -05:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Remove vestigate HUDSON_PUBLISH_DOCS reference 2017-09-02 08:41:34 -05: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

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