diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api_coveragedata.rst | 1 | ||||
| -rw-r--r-- | doc/api_plugin.rst | 1 | ||||
| -rw-r--r-- | doc/changes.rst | 2 | ||||
| -rw-r--r-- | doc/config.rst | 3 | ||||
| -rw-r--r-- | doc/contexts.rst | 2 | ||||
| -rw-r--r-- | doc/dbschema.rst | 10 |
6 files changed, 7 insertions, 12 deletions
diff --git a/doc/api_coveragedata.rst b/doc/api_coveragedata.rst index b3b64328..3ab741ec 100644 --- a/doc/api_coveragedata.rst +++ b/doc/api_coveragedata.rst @@ -11,6 +11,7 @@ The CoverageData class .. versionadded:: 4.0 .. module:: coverage + :noindex: .. autoclass:: CoverageData :members: diff --git a/doc/api_plugin.rst b/doc/api_plugin.rst index d070e2bf..91219247 100644 --- a/doc/api_plugin.rst +++ b/doc/api_plugin.rst @@ -13,6 +13,7 @@ Plug-in classes .. module:: coverage + :noindex: The CoveragePlugin class ------------------------ diff --git a/doc/changes.rst b/doc/changes.rst index 1dd7b911..73d1532b 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -3,6 +3,4 @@ .. _changes: -.. module:: coverage - .. include:: ../CHANGES.rst diff --git a/doc/config.rst b/doc/config.rst index 04daa01d..35584f01 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -17,7 +17,6 @@ Configuration reference .. :history: 20150124T173400, updated for 4.0a4 .. :history: 20150802T174600, updated for 4.0b1 -.. module:: coverage Coverage.py options can be specified in a configuration file. This makes it easier to re-run coverage.py with consistent settings, and also allows for @@ -162,7 +161,7 @@ in measurement or reporting. Ignored if ``source`` is set. See :ref:`source` for details. ``note`` (string): an arbitrary string that will be written to the data file. -You can use the :meth:`CoverageData.run_infos` method to retrieve this string +You can use the :meth:`.CoverageData.run_infos` method to retrieve this string from a data file. ``omit`` (multi-string): a list of file name patterns, the files to leave out diff --git a/doc/contexts.rst b/doc/contexts.rst index 6a1293fd..8f7854f9 100644 --- a/doc/contexts.rst +++ b/doc/contexts.rst @@ -11,8 +11,6 @@ Measurement contexts .. versionadded:: 5.0 -.. module:: coverage - Coverage.py measures whether code was run, but it can also record the context in which it was run. This can provide more information to help you understand the behavior of your tests. diff --git a/doc/dbschema.rst b/doc/dbschema.rst index aa838fdf..c57de92e 100644 --- a/doc/dbschema.rst +++ b/doc/dbschema.rst @@ -9,17 +9,15 @@ Coverage.py database schema .. versionadded:: 5.0 -.. module:: coverage - Coverage.py stores data in a SQLite database, by default called ``.coverage``. -For most needs, the :class:`CoverageData` API will be sufficient, and should be -preferred to accessing the database directly. Only advanced uses will need to -use the database. +For most needs, the :class:`.CoverageData` API will be sufficient, and should +be preferred to accessing the database directly. Only advanced uses will need +to use the database. You can use SQLite tools such as the :mod:`sqlite3 <python:sqlite3>` module in the Python standard library to access the data. Some data is stored in a packed format that will need custom functions to access. See -:func:`register_sqlite_functions`. +:func:`.register_sqlite_functions`. Database schema |