History

Sean McGinnis 5d870b5621 Remove run_tests.sh wrapper

The run_tests.sh mechanism for performing operations
is no longer the preferred approach. It is now better
to just run tox. There are also issues with enforcing
upper constraints that may cause test runs to fail.

To get rid of confusion by having two different ways
to run unit tests, flake8 checks, etc., it's probably
better to just remove the run_tests.sh script completely
and direct folks to use tox instead. This way we are all
consistent and there is less concern that changes will
be made to one and not the other.

Change-Id: I03f4b49cffd9f64e4eb3bdc27995d543be9efa43

2016-12-09 14:15:54 -06:00

ext

Merge "Add driver list to doc build"

2016-07-29 02:24:22 +00:00

source

Remove run_tests.sh wrapper

2016-12-09 14:15:54 -06:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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

Update doc README and remove old Makefile

2016-07-23 18:04:04 -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: 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