summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 19:13:17 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 19:13:17 +0100
commit28730e86e839dfae1fcbccbf701215663d52bd80 (patch)
treefca6e5db95a587f5b91b3f1a5a811cbecb6e9eb1 /docs/userguide
parentf94e4ad28509f14a2184cb18188540c7a5bf086e (diff)
parent6e042281e7add1fae30e5cbaf51fc57430a9547e (diff)
downloadpython-setuptools-git-28730e86e839dfae1fcbccbf701215663d52bd80.tar.gz
docs: Add two footnotes about PEP 660 support (#3407)
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/pyproject_config.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst
index 28eb39d1..709bf919 100644
--- a/docs/userguide/pyproject_config.rst
+++ b/docs/userguide/pyproject_config.rst
@@ -7,8 +7,8 @@ Configuring setuptools using ``pyproject.toml`` files
.. note:: New in 61.0.0
.. important::
- For the time being, ``pip`` still might require a ``setup.py`` file
- to support :doc:`editable installs <pip:cli/pip_install>`.
+ For the time being [#pep660-status]_, ``pip`` still might require a ``setup.py`` file
+ to support :doc:`editable installs <pip:cli/pip_install>` [#setupcfg-caveats]_.
A simple script will suffice, for example:
@@ -214,6 +214,13 @@ however please keep in mind that all non-comment lines must conform with :pep:`5
.. rubric:: Notes
+.. [#pep660-status] Editable install without ``setup.py`` will be supported in
+ future versions of ``setuptools``. Check https://github.com/pypa/setuptools/issues/2816 for detail.
+
+.. [#setupcfg-caveats] ``pip`` may allow editable install only with ``pyproject.toml``
+ and ``setup.cfg``. However, this behavior may not be consistent over various build
+ tools. Having a ``setup.py`` is still recommended if you rely on one of these tools.
+
.. [#entry-points] Dynamic ``scripts`` and ``gui-scripts`` are a special case.
When resolving these metadata keys, ``setuptools`` will look for
``tool.setuptool.dynamic.entry-points``, and use the values of the