summaryrefslogtreecommitdiff
path: root/docs/userguide/pyproject_config.rst
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 20:55:16 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 20:55:16 +0100
commit228f3e99d89a4f200e782a71b02ab0425f5e1dc4 (patch)
tree74180f085a8465a082d4df79c29090b82dff1d0a /docs/userguide/pyproject_config.rst
parent5aa389c770e0d58eb8c0999f8888fb65845d4f73 (diff)
downloadpython-setuptools-git-228f3e99d89a4f200e782a71b02ab0425f5e1dc4.tar.gz
Update docs to reflect the implementation of PEP 660
Diffstat (limited to 'docs/userguide/pyproject_config.rst')
-rw-r--r--docs/userguide/pyproject_config.rst16
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst
index 709bf919..b1d4a4e3 100644
--- a/docs/userguide/pyproject_config.rst
+++ b/docs/userguide/pyproject_config.rst
@@ -7,10 +7,10 @@ Configuring setuptools using ``pyproject.toml`` files
.. note:: New in 61.0.0
.. important::
- 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:
+ If compatibility with legacy builds or versions of tools that don't support
+ certain packaging standards (e.g. :pep:`517` or :pep:`660`), a simple ``setup.py``
+ script can be added to your project [#setupcfg-caveats]_
+ (while keeping the configuration in ``pyproject.toml``):
.. code-block:: python
@@ -214,12 +214,10 @@ 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.
+ and ``setup.cfg``. However, this behavior may not be consistent over various ``pip``
+ versions and other packaging-related tools
+ (``setup.py`` is more reliable on those scenarios).
.. [#entry-points] Dynamic ``scripts`` and ``gui-scripts`` are a special case.
When resolving these metadata keys, ``setuptools`` will look for