Skip to content

Add pyproject.toml configuration example #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2021
Merged

Add pyproject.toml configuration example #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.rst
View file
Open in desktop
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