diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst index 98d1a4e3bb6c..c2111ef2309e 100644 --- a/doc/devel/testing.rst +++ b/doc/devel/testing.rst @@ -18,11 +18,21 @@ The following software is required to run the tests: - nose_, version 1.0 or later + - `mock `_, when running python + versions < 3.3 + - `Ghostscript `_ (to render PDF files) - `Inkscape `_ (to render SVG files) +Optionally you can install: + + - `coverage `_ to collect coverage + information + + - `pep8 `_ to test coding standards + Running the tests ----------------- @@ -36,6 +46,13 @@ The script can take any of the usual `nosetest arguments`_, such as ``--with-coverage`` enable collecting coverage information =================== =========== +Additionally it is possible to run only coding standard test or disable them: + +=================== =========== +``--pep8`` run only PEP8 checks +``--no-pep8`` disable PEP8 checks +=================== =========== + To run a single test from the command line, you can provide a dot-separated path to the module followed by the function separated by a colon, e.g., (this is assuming the test is installed)::