summaryrefslogtreecommitdiff
path: root/docs/userguide/pyproject_config.rst
diff options
context:
space:
mode:
authorkngwyu <yuji.kngw.80s.revive@gmail.com>2022-06-24 19:06:33 +0900
committerkngwyu <yuji.kngw.80s.revive@gmail.com>2022-06-28 18:39:28 +0900
commit608e304df76615d9253b115cdcff4d735b6f33cc (patch)
tree6da045874eeff3ee44bd7a780bc626845ec4d89c /docs/userguide/pyproject_config.rst
parent669be5ef1d93e2fa088cc5d1dfd999e0db61abcf (diff)
downloadpython-setuptools-git-608e304df76615d9253b115cdcff4d735b6f33cc.tar.gz
[Docs] Add two footnotes about editable install
... for editable install with pyproject.toml
Diffstat (limited to 'docs/userguide/pyproject_config.rst')
-rw-r--r--docs/userguide/pyproject_config.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst
index 9ce983b4..c3977d13 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:
@@ -211,6 +211,14 @@ 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 from
+ ``setuptools >= 63.0.0``, but this feature will remain experimental for a while.
+ 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, and having a ``setup.py`` is still recommended.
+
.. [#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