diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.rst | 9 | ||||
| -rw-r--r-- | doc/api_exceptions.rst | 11 |
2 files changed, 16 insertions, 4 deletions
diff --git a/doc/api.rst b/doc/api.rst index 855e3ec6..f5112165 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -9,10 +9,10 @@ Coverage.py API There are a few different ways to use coverage.py programmatically. -The API to coverage.py is in a module called `coverage`. -Most of the interface is in the :class:`coverage.Coverage` class. Methods on -the Coverage object correspond roughly to operations available in the command -line interface. For example, a simple use would be:: +The API to coverage.py is in a module called :mod:`coverage`. Most of the +interface is in the :class:`coverage.Coverage` class. Methods on the Coverage +object correspond roughly to operations available in the command line +interface. For example, a simple use would be:: import coverage @@ -48,6 +48,7 @@ only. :ref:`dbschema` explains more. :maxdepth: 1 api_coverage + api_exceptions api_module api_plugin api_coveragedata diff --git a/doc/api_exceptions.rst b/doc/api_exceptions.rst new file mode 100644 index 00000000..38109657 --- /dev/null +++ b/doc/api_exceptions.rst @@ -0,0 +1,11 @@ +.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +.. _api_exceptions: + +Coverage exceptions +------------------- + +.. automodule:: coverage.exceptions + :noindex: + :members: |