DebugClients/Python/coverage/doc/README.rst

changeset 6219
d6c795b5ce33
parent 5178
878ce843ca9f
child 6649
f1b3a73831c9
--- a/DebugClients/Python/coverage/doc/README.rst	Sat Apr 07 13:17:06 2018 +0200
+++ b/DebugClients/Python/coverage/doc/README.rst	Sat Apr 07 13:35:10 2018 +0200
@@ -9,20 +9,39 @@
 
 |  |license| |versions| |status| |docs|
 |  |ci-status| |win-ci-status| |codecov|
-|  |kit| |format| |downloads|
+|  |kit| |format| |saythanks|
+
+.. downloads badge seems to be broken... |downloads|
 
 Coverage.py measures code coverage, typically during test execution. It uses
 the code analysis tools and tracing hooks provided in the Python standard
 library to determine which lines are executable, and which have been executed.
 
-Coverage.py runs on CPython 2.6, 2.7, and 3.3 through 3.6; PyPy 4.0 and 5.1;
-and PyPy3 2.4.
+Coverage.py runs on many versions of Python:
+
+* CPython 2.6, 2.7 and 3.3 through 3.7.
+* PyPy2 5.10 and PyPy3 5.10.
+* Jython 2.7.1, though not for reporting.
+* IronPython 2.7.7, though not for reporting.
+
+Documentation is on `Read the Docs`_.  Code repository and issue tracker are on
+`Bitbucket`_, with a mirrored repository on `GitHub`_.
 
-Documentation is on `Read the Docs <http://coverage.readthedocs.io>`_.
-Code repository and issue tracker are on `Bitbucket <http://bitbucket.org/ned/coveragepy>`_,
-with a mirrored repository on `GitHub <https://github.com/nedbat/coveragepy>`_.
+.. _Read the Docs: https://coverage.readthedocs.io/
+.. _Bitbucket: https://bitbucket.org/ned/coveragepy
+.. _GitHub: https://github.com/nedbat/coveragepy
+
+
+**New in 4.5:** Configurator plug-ins.
 
-**New in 4.1:** much-improved branch coverage.
+New in 4.4: Suppressable warnings, continuous coverage measurement.
+
+New in 4.3: HTML ``--skip-covered``, sys.excepthook support, tox.ini
+support.
+
+New in 4.2: better support for multiprocessing and combining data.
+
+New in 4.1: much-improved branch coverage.
 
 New in 4.0: ``--concurrency``, plugins for non-Python files, setup.cfg
 support, --skip-covered, HTML filtering, and more than 50 issues closed.
@@ -31,25 +50,36 @@
 Getting Started
 ---------------
 
-See the `quick start <http://coverage.readthedocs.io/#quick-start>`_
-section of the docs.
+See the `Quick Start section`_ of the docs.
+
+.. _Quick Start section: https://coverage.readthedocs.io/#quick-start
+
+
+Contributing
+------------
+
+See the `Contributing section`_ of the docs.
+
+.. _Contributing section: https://coverage.readthedocs.io/en/latest/contributing.html
 
 
 License
 -------
 
-Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0.
-For details, see https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt.
+Licensed under the `Apache 2.0 License`_.  For details, see `NOTICE.txt`_.
+
+.. _Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
+.. _NOTICE.txt: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
 
 
 .. |ci-status| image:: https://travis-ci.org/nedbat/coveragepy.svg?branch=master
     :target: https://travis-ci.org/nedbat/coveragepy
     :alt: Build status
-.. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/bitbucket/ned/coveragepy?svg=true
+.. |win-ci-status| image:: https://ci.appveyor.com/api/projects/status/kmeqpdje7h9r6vsf/branch/master?svg=true
     :target: https://ci.appveyor.com/project/nedbat/coveragepy
     :alt: Windows build status
 .. |docs| image:: https://readthedocs.org/projects/coverage/badge/?version=latest&style=flat
-    :target: http://coverage.readthedocs.io
+    :target: https://coverage.readthedocs.io/
     :alt: Documentation
 .. |reqs| image:: https://requires.io/github/nedbat/coveragepy/requirements.svg?branch=master
     :target: https://requires.io/github/nedbat/coveragepy/requirements/?branch=master
@@ -72,6 +102,9 @@
 .. |license| image:: https://img.shields.io/pypi/l/coverage.svg
     :target: https://pypi.python.org/pypi/coverage
     :alt: License
-.. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master
+.. |codecov| image:: http://codecov.io/github/nedbat/coveragepy/coverage.svg?branch=master&precision=2
     :target: http://codecov.io/github/nedbat/coveragepy?branch=master
     :alt: Coverage!
+.. |saythanks| image:: https://img.shields.io/badge/saythanks.io-%E2%98%BC-1EAEDB.svg
+    :target: https://saythanks.io/to/nedbat
+    :alt: Say thanks :)

eric ide

mercurial