summaryrefslogtreecommitdiff
path: root/doc/api_coverage.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api_coverage.rst')
-rw-r--r--doc/api_coverage.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/api_coverage.rst b/doc/api_coverage.rst
new file mode 100644
index 00000000..69b64c3b
--- /dev/null
+++ b/doc/api_coverage.rst
@@ -0,0 +1,21 @@
+.. 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_coverage:
+
+The Coverage class
+------------------
+
+.. autoclass:: coverage.Coverage
+ :members:
+ :exclude-members: use_cache, sys_info
+ :special-members: __init__
+
+
+Starting coverage.py automatically
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function is used to start coverage measurement automatically when Python
+starts. See :ref:`subprocess` for details.
+
+.. autofunction:: coverage.process_startup