summaryrefslogtreecommitdiff
path: root/doc/api_plugin.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
commit1df530629016e31cef71c98ce70df315499161fb (patch)
treeeeab8a877697093141e6c5b1fe38ef4dd7ffe7e1 /doc/api_plugin.rst
parentbe4a96d85bd5dd8328fcde9a77ee9a25f096881c (diff)
downloadpython-coveragepy-1df530629016e31cef71c98ce70df315499161fb.tar.gz
Separate the plugin API docs from the 'using plugins' docs.
Diffstat (limited to 'doc/api_plugin.rst')
-rw-r--r--doc/api_plugin.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/api_plugin.rst b/doc/api_plugin.rst
new file mode 100644
index 0000000..dbea58b
--- /dev/null
+++ b/doc/api_plugin.rst
@@ -0,0 +1,35 @@
+.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+.. For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
+
+.. _api_plugin:
+
+==============
+The Plugin API
+==============
+
+.. :history: 20150815T132400, new doc for 4.0b2
+
+.. versionadded:: 4.0
+
+.. module:: coverage
+
+The CoveragePlugin class
+------------------------
+
+.. autoclass:: CoveragePlugin
+ :members:
+ :member-order: bysource
+
+The FileTracer class
+--------------------
+
+.. autoclass:: FileTracer
+ :members:
+ :member-order: bysource
+
+The FileReporter class
+----------------------
+
+.. autoclass:: FileReporter
+ :members:
+ :member-order: bysource