From 386cf57c94631d02d6e2d266217fd2caaba09320 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sun, 25 Jan 2015 14:22:07 -0500 Subject: Rename plugin.rst to plugins.rst --HG-- rename : doc/plugin.rst => doc/plugins.rst --- doc/index.rst | 2 +- doc/plugin.rst | 53 ----------------------------------------------------- doc/plugins.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 54 insertions(+), 54 deletions(-) delete mode 100644 doc/plugin.rst create mode 100644 doc/plugins.rst diff --git a/doc/index.rst b/doc/index.rst index 80cdd736..0069fcc7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -167,7 +167,7 @@ More information branch subprocess api - plugin + plugins contributing trouble faq 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: diff --git a/doc/plugins.rst b/doc/plugins.rst new file mode 100644 index 00000000..d8f4ef56 --- /dev/null +++ b/doc/plugins.rst @@ -0,0 +1,53 @@ +.. _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: -- cgit v1.2.1