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 | |
| 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')
| -rw-r--r-- | doc/api.rst | 39 | ||||
| -rw-r--r-- | doc/api_coverage.rst | 21 | ||||
| -rw-r--r-- | doc/api_coveragedata.rst | 11 | ||||
| -rw-r--r-- | doc/conf.py | 2 |
4 files changed, 43 insertions, 30 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 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 diff --git a/doc/api_coveragedata.rst b/doc/api_coveragedata.rst new file mode 100644 index 00000000..dec505c1 --- /dev/null +++ b/doc/api_coveragedata.rst @@ -0,0 +1,11 @@ +.. 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_coveragedata: + +The CoverageData class +---------------------- + +.. autoclass:: coverage.CoverageData + :members: + :special-members: __init__ diff --git a/doc/conf.py b/doc/conf.py index de90dd74..1be0c4d8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -58,7 +58,7 @@ copyright = u'2009\N{EN DASH}2015, Ned Batchelder' # The short X.Y version. version = '4.0' # The full version, including alpha/beta/rc tags. -release = '4.0a6' +release = '4.0b1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. |
