diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2015-10-14 06:14:40 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-10-14 06:14:40 -0400 |
commit | 5d725e5e3280387feb24ea6112eea339ed8d3571 (patch) | |
tree | 10395dd5bc751cefa5c68e41a1f9b76b8510dde7 | |
parent | da4830f117befaf3a5610aeb1b1e5158ba92d97c (diff) | |
download | python-coveragepy-git-5d725e5e3280387feb24ea6112eea339ed8d3571.tar.gz |
Make doc checking better, and fix two doc errors.
-rw-r--r-- | coverage/data.py | 2 | ||||
-rw-r--r-- | doc/config.rst | 1 | ||||
-rw-r--r-- | tox.ini | 7 |
3 files changed, 8 insertions, 2 deletions
diff --git a/coverage/data.py b/coverage/data.py index 324d7335..17cf73ce 100644 --- a/coverage/data.py +++ b/coverage/data.py @@ -576,7 +576,7 @@ class CoverageData(object): def add_to_hash(self, filename, hasher): """Contribute `filename`'s data to the `hasher`. - `hasher` is a :class:`coverage.misc.Hasher` instance to be updated with + `hasher` is a `coverage.misc.Hasher` instance to be updated with the file's data. It should only get the results data, not the run data. diff --git a/doc/config.rst b/doc/config.rst index 1b451b30..4ac63d4c 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -17,6 +17,7 @@ Configuration files .. :history: 20150124T173400, updated for 4.0a4 .. :history: 20150802T174600, updated for 4.0b1 +.. module:: coverage Coverage.py options can be specified in a configuration file. This makes it easier to re-run coverage.py with consistent settings, and also allows for @@ -50,9 +50,14 @@ basepython = pypy2.6 basepython = pypy3-2.4 [testenv:doc] +# Build the docs so we know if they are successful. We build twice: once with +# -q to get all warnings, and once with -QW to get a success/fail status +# return. basepython = python2 deps = -rdoc/requirements.pip -commands = sphinx-build -aEnq doc doc/_build/html +commands = + sphinx-build -aEnq doc doc/_build/html + sphinx-build -aEnQW doc doc/_build/html # Yes, pep8 will read its settings from tox.ini! [pep8] |