Skip to content

Commit

Permalink
Add pyproject.toml configuration example
Browse files Browse the repository at this point in the history
Closes #77
  • Loading branch information
jaap3 authored and nedbat committed Nov 4, 2021
1 parent 5d499a6 commit 7b1628b
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ Configuration
~~~~~~~~~~~~~

The Django template plugin uses some existing settings from your
.coveragerc file. The ``source=``, ``include=``, and ``omit=`` options
``.coveragerc`` file. The ``source=``, ``include=``, and ``omit=`` options
control what template files are included in the report.

The plugin can find unused template and include them in your results. By
default, it will look for files in your templates directory with an extension
of .html, .htm, or .txt. You can configure it to look for a different set of
of ``.html``, ``.htm``, or ``.txt``. You can configure it to look for a different set of
extensions if you like::

[run]
Expand All @@ -86,6 +86,15 @@ extensions if you like::
[django_coverage_plugin]
template_extensions = html, txt, tex, email

If you use ``pyproject.toml`` for tool configuration use::

[tool.coverage.run]
plugins = [
'django_coverage_plugin',
]

[tool.coverage.django_coverage_plugin]
template_extensions = 'html, txt, tex, email'

Caveats
~~~~~~~
Expand Down

0 comments on commit 7b1628b

Please sign in to comment.