floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove setup.cfg usage from docs

This commit is contained in:
Ronny Pfannschmidt 2022-07-12 10:08:02 +02:00
parent 7012fe3183
commit 3e01de512a
1 changed files with 2 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/en/reference/customize.rst
View File

@ -79,7 +79,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
.. code-block:: ini .. code-block:: ini
# tox.ini # tox.ini
[pytest] [tool:pytest]
minversion = 6.0 minversion = 6.0
addopts = -ra -q addopts = -ra -q
testpaths = testpaths =
@ -90,26 +90,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
setup.cfg setup.cfg
~~~~~~~~~ ~~~~~~~~~
``setup.cfg`` files are general purpose configuration files, used originally by :doc:`distutils <distutils/configfile>`, and can also be used to hold pytest configuration ``setup.cfg`` file usage for pytest has been deprecated, its recommended to use ``tox.ini`` or ``pyproject.toml``
if they have a ``[tool:pytest]`` section.
.. code-block:: ini
# setup.cfg
[tool:pytest]
minversion = 6.0
addopts = -ra -q
testpaths =
tests
integration
.. warning::
Usage of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg``
files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track
down problems.
When possible, it is recommended to use the latter files, or ``pyproject.toml``, to hold your
pytest configuration.
.. _rootdir: .. _rootdir: