summaryrefslogtreecommitdiff
path: root/doc/api.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-08-02 11:45:41 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-08-02 11:45:41 -0400
commit959447537d8d8f4d91f5bf25b810e49bdaffddf6 (patch)
tree8717ac0a5d4639ba590b9530199e262dc40d30e5 /doc/api.rst
parent85ad93b467bc5fccbcc089e0d0ad5dee4cc38e9d (diff)
downloadpython-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.rst')
-rw-r--r--doc/api.rst39
1 files changed, 10 insertions, 29 deletions
diff --git a/doc/api.rst b/doc/api.rst
index 2904058b..1c20d3a4 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -15,10 +15,10 @@ Coverage.py API
.. :history: 20140819T132600, change class name to Coverage
-The API to coverage.py is very simple, contained in a single module called
-`coverage`. Most of the interface is in a single class, called
-`Coverage`. Methods on the Coverage object correspond roughly to operations
-available in the command line interface. For example, a simple use would be::
+The API to coverage.py is very simple, contained in a module called `coverage`.
+Most of the interface is in the :class:`coverage.Coverage` class. Methods on
+the Coverage object correspond roughly to operations available in the command
+line interface. For example, a simple use would be::
import coverage
@@ -32,30 +32,11 @@ available in the command line interface. For example, a simple use would be::
cov.html_report()
+The :class:`coverage.CoverageData` class provides access to coverage data
+stored in coverage.py data files.
-The Coverage class
-------------------
+.. toctree::
+ :maxdepth: 1
-.. module:: coverage
-
-.. autoclass:: Coverage
- :members:
- :exclude-members: use_cache
- :special-members: __init__
-
-
-The CoverageData class
-----------------------
-
-.. autoclass:: CoverageData
- :members:
- :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:: process_startup
+ api_coverage
+ api_coveragedata