summaryrefslogtreecommitdiff
path: root/doc/plugins.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-08-15 13:41:35 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-08-15 13:41:35 -0400
commit15e6f52735225aa2992ade5644d605d2d412f96a (patch)
tree13a593cef4ea1f20503024e0f20da5022865fa81 /doc/plugins.rst
parentcac28dc30e095ff336be3df69363fa9100e0038c (diff)
downloadpython-coveragepy-git-15e6f52735225aa2992ade5644d605d2d412f96a.tar.gz
Separate the plugin API docs from the 'using plugins' docs.
Diffstat (limited to 'doc/plugins.rst')
-rw-r--r--doc/plugins.rst21
1 files changed, 3 insertions, 18 deletions
diff --git a/doc/plugins.rst b/doc/plugins.rst
index 027b0b8f..93e7359c 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -15,6 +15,9 @@ Coverage.py's behavior can be extended with third-party plugins. A plugin is a
separately installed Python class that you register in your .coveragerc.
Plugins can be used to implement coverage measurement for non-Python files.
+Information about using plugins is on this page. To write a plugin, see
+:ref:`api_plugin`.
+
.. versionadded:: 4.0
@@ -49,21 +52,3 @@ coverage.py plugin called ``something.plugin``.
what they are.
#. Run your tests with coverage.py as you usually would.
-
-
-Plugin API
-----------
-
-.. module:: coverage
-
-.. autoclass:: CoveragePlugin
- :members:
- :member-order: bysource
-
-.. autoclass:: FileTracer
- :members:
- :member-order: bysource
-
-.. autoclass:: FileReporter
- :members:
- :member-order: bysource