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 | f9b9abb5b81bd9efbb7f8b283d28af2bbf7808c7 (patch) | |
| tree | 728bc1f785c7fa2bf25a8e1b1019273e7e7b7f16 /doc/api_coverage.rst | |
| parent | 4031cbbe269ad31b63b9533dca2fa22510bcb3ba (diff) | |
| download | python-coveragepy-f9b9abb5b81bd9efbb7f8b283d28af2bbf7808c7.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 0000000..69b64c3 --- /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 |