Skip to content

Commit 7129605

Browse files
remove setup.cfg usage from docs
1 parent a939b37 commit 7129605

1 file changed

Lines changed: 2 additions & 21 deletions

File tree

‎doc/en/reference/customize.rst‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
7979
.. code-block:: ini
8080
8181
# tox.ini
82-
[pytest]
82+
[tool:pytest]
8383
minversion = 6.0
8484
addopts = -ra -q
8585
testpaths =
@@ -90,26 +90,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
9090
setup.cfg
9191
~~~~~~~~~
9292

93-
``setup.cfg`` files are general purpose configuration files, used originally by :doc:`distutils <distutils/configfile>`, and can also be used to hold pytest configuration
94-
if they have a ``[tool:pytest]`` section.
95-
96-
.. code-block:: ini
97-
98-
# setup.cfg
99-
[tool:pytest]
100-
minversion = 6.0
101-
addopts = -ra -q
102-
testpaths =
103-
tests
104-
integration
105-
106-
.. warning::
107-
108-
Usage of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg``
109-
files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track
110-
down problems.
111-
When possible, it is recommended to use the latter files, or ``pyproject.toml``, to hold your
112-
pytest configuration.
93+
``setup.cfg`` file usage for pytest has been deprecated, its recommended to use ``tox.ini`` or ``pyproject.toml``
11394

11495

11596
.. _rootdir:

0 commit comments

Comments
 (0)