diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-02 11:45:41 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-02 11:45:41 -0400 |
| commit | 959447537d8d8f4d91f5bf25b810e49bdaffddf6 (patch) | |
| tree | 8717ac0a5d4639ba590b9530199e262dc40d30e5 /doc/api_coverage.rst | |
| parent | 85ad93b467bc5fccbcc089e0d0ad5dee4cc38e9d (diff) | |
| download | python-coveragepy-git-959447537d8d8f4d91f5bf25b810e49bdaffddf6.tar.gz | |
Split the api docs into separate pages.
The :meth: references are annoying, and some aren't right yet. :(
Diffstat (limited to 'doc/api_coverage.rst')
| -rw-r--r-- | doc/api_coverage.rst | 21 |
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 |