From e9220659b04c150c4e0145be34b521713d780e9c Mon Sep 17 00:00:00 2001 From: Aron Griffis Date: Sun, 29 Nov 2015 15:08:24 -0500 Subject: [PATCH] Add documentation for running coverage locally. --- docs/testing.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/testing.rst b/docs/testing.rst index adbf139..2042c91 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -39,3 +39,22 @@ Python 3 specific, then end the name of the Python code file as ``_py2.py`` or ``_py3.py`` appropriately. For further options refer to the documentation for ``tox``. + +Coverage +-------- + +Coverage is collected and sent to `Coveralls `_ when +running the tests automatically in `Travis CI `_. +To collect and view coverage results locally, here's the sequence of +commands: + +:: + + export COVERAGE_CMD="coverage run -m" + export COVERAGE_DEP=coverage + tox + coverage combine + coverage html --ignore-errors + +At this point there's a directly called ``htmlcov`` with the formatted +results.