diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2015-01-25 14:22:07 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-01-25 14:22:07 -0500 |
| commit | 386cf57c94631d02d6e2d266217fd2caaba09320 (patch) | |
| tree | 745e5c16c556b8743a54e95f81b786c7be86c0f9 /doc/plugin.rst | |
| parent | 8751ff59c235e1d20a19a8e7356a9e3cce236ca5 (diff) | |
| download | python-coveragepy-git-386cf57c94631d02d6e2d266217fd2caaba09320.tar.gz | |
Rename plugin.rst to plugins.rst
--HG--
rename : doc/plugin.rst => doc/plugins.rst
Diffstat (limited to 'doc/plugin.rst')
| -rw-r--r-- | doc/plugin.rst | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/doc/plugin.rst b/doc/plugin.rst deleted file mode 100644 index d8f4ef56..00000000 --- a/doc/plugin.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _plugins: - -======= -Plugins -======= - -.. :history: 20150124T143000, new page. - -Coverage.py's behavior can be extended by writing plugins. A plugin is a -separately installed Python class that you register in your .coveragerc. -Plugins can be used to implement coverage measurement for non-Python files. - -Using plugins -------------- - -To use a coverage.py plugin, you install it, and configure it. For this -example, let's say you want to use one called fred_plugin. - -#. Install the plugin as you would any other Python package:: - - pip install fred_plugin - -#. Configure coverage.py to use the plugin. You do this by editing (or - creating) your .coveragerc file, as described in :ref:`config`. The - ``plugins`` setting indicates your plugin:: - - [run] - plugins = - fred_plugin - -#. Run your tests as you usually would. NOTE: You will see a warning when - coverage starts:: - - Coverage.py warning: Setting timid=True to support plugins. - - This means that coverage will run slower than it usually would. This - limitation is part of the initial alpha release, it will be gone in the - final version. - - -Plugin API ----------- - -.. module:: coverage.plugin - -.. autoclass:: CoveragePlugin - :members: - -.. autoclass:: FileTracer - :members: - -.. autoclass:: FileReporter - :members: |
