openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Andreas Jaeger 0f6bbe303f Prepare for using standard python tests 
Add simple script to setup mysql and postgresql databases, this script
can be run by users during testing and will be run by CI systems for
specific setup before running unit tests. This is exactly what is
currently done by OpenStack CI in project-config.

This allows to change in project-config the python-db jobs to
python-jobs since python-jobs will call this script initially.

See also
http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html

Update devref for this.

Needed-By: I628f825d9200f7951eae46b7be78b111b1a8141c
Change-Id: If549e6f108ec6184a432d5050da4386efe794a4e
(cherry picked from commit 1c91c0f033)
 		2017-02-07 06:48:13 +01:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Prepare for using standard python tests 2017-02-07 06:48:13 +01:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst Update doc README and remove old Makefile 2016-07-23 18:04:04 -05: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 Initial fork out of Nova. 2012-05-03 10:48:26 -07: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: http://docs.openstack.org/developer/cinder/

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