Merge pull request #4337 from stephenfin/the-great-toxification

The great toxification (part 6)

.gitignore

@@ -13,6 +13,7 @@ TAGS
 .tox
 .venv
 .coverage
+htmlcov
 .DS_Store
 sphinx/pycode/Grammar*pickle
 distribute-*

.travis.yml

@@ -14,13 +14,17 @@ matrix:
     - python: 'pypy'
       env: TOXENV=pypy
     - python: '2.7'
-      env: TOXENV=du13
+      env:
+        - TOXENV=du13
+        - PYTEST_ADDOPTS = --cov sphinx --cov-append --cov-config setup.cfg
     - python: '3.4'
       env: TOXENV=py34
     - python: '3.5'
       env: TOXENV=py35
     - python: '3.6'
-      env: TOXENV=py36
+      env:
+        - TOXENV=py36
+        - PYTEST_ADDOPTS = --cov sphinx --cov-append --cov-config setup.cfg
     - python: 'nightly'
       env: TOXENV=py37
     - python: '3.6'
@@ -35,7 +39,10 @@ addons:
       - imagemagick
 
 install:
-  - pip install -U tox
+  - pip install -U tox codecov
 
 script:
   - tox -- -v
+
+after_success:
+  - codecov

README.rst

@@ -22,6 +22,10 @@
    :target: https://circleci.com/gh/sphinx-doc/sphinx
    :alt: Build Status (CircleCI)
 
+.. image:: https://codecov.io/gh/sphinx-doc/sphinx/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/sphinx-doc/sphinx
+   :alt: Code Coverage Status (Codecov)
+
 Sphinx is a tool that makes it easy to create intelligent and beautiful
 documentation for Python projects (or other documents consisting of multiple
 reStructuredText sources), written by Georg Brandl.  It was originally created

setup.cfg

@@ -43,3 +43,17 @@ follow_imports = skip
 incremental = True
 check_untyped_defs = True
 warn_unused_ignores = True
+
+[coverage:run]
+branch = True
+source = sphinx
+
+[coverage:report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+    # Don't complain if tests don't hit defensive assertion code:
+    raise NotImplementedError
+    # Don't complain if non-runnable code isn't run:
+    if __name__ == .__main__.:
+ignore_errors = True

tox.ini

@@ -8,7 +8,6 @@ passenv =
 description =
     py{27,34,35,36,py}: Run unit tests against {envname}.
     du{11,12,13,14}: Run unit tests with the given version of docutils.
-    coverage: Run code coverage checks.
 
 # TODO(stephenfin) Replace this with the 'extras' config option when tox 2.4 is
 # widely available, likely some time after the Ubuntu 18.04 release
@@ -22,7 +21,6 @@ deps =
     du14: docutils==0.14
 setenv =
     SPHINX_TEST_TEMPDIR = {envdir}/testbuild
-    coverage: PYTEST_ADDOPTS = --cov sphinx
 commands=
     {envpython} -Wall tests/run.py --durations 25 {posargs}
 
@@ -41,6 +39,15 @@ deps =
 commands =
     pylint --rcfile utils/pylintrc sphinx
 
+[testenv:coverage]
+description =
+    Run code coverage checks.
+setenv =
+    PYTEST_ADDOPTS = --cov sphinx --cov-config {toxinidir}/setup.cfg
+commands =
+    {[testenv]commands}
+    coverage report
+
 [testenv:mypy]
 description =
     Run type checks.