summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrazer McLean <frazer@frazermclean.co.uk>2019-09-16 22:24:53 +0200
committerNed Batchelder <ned@nedbatchelder.com>2019-11-03 21:27:42 -0500
commitf97d0750a91e53bec387528344c1ca3bf86e1d08 (patch)
treeb240becda198190abdf545f02ce116ca3eae8808 /doc
parent1c06204a8b1db6cd5f53c553c42f3ef8229d6b20 (diff)
downloadpython-coveragepy-git-f97d0750a91e53bec387528344c1ca3bf86e1d08.tar.gz
TOML support for pyproject.toml and other config files
Squashed and rebased from https://github.com/nedbat/coveragepy/pull/699 Missing getfloat TOMLConfigParser -> TomlConfigParser fix getfloat for int Move TomlConfigParser Add name to contributors Import toml in backward.py fix indentation Don't ignore TomlDecodeError Raise if TomlConfigParser is used without toml installed Add tests for TOML config Fix test on Python 2 Mention toml support in documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/config.rst b/doc/config.rst
index d7623532..b8a3d328 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -29,7 +29,10 @@ Coverage.py will read settings from other usual configuration files if no other
configuration file is used. It will automatically read from "setup.cfg" or
"tox.ini" if they exist. In this case, the section names have "coverage:"
prefixed, so the ``[run]`` options described below will be found in the
-``[coverage:run]`` section of the file.
+``[coverage:run]`` section of the file. If Coverage.py is installed with the
+``toml`` extra (``pip install coverage[toml]``), it will automatically read
+from "pyproject.toml". Configuration must be within the `[tool.coverage]`
+section, e.g. ``[tool.coverage.run]`.
Syntax