From 8abf6dca26e00557bb4d32e25aaed27d1d00e3ef Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Mon, 13 Feb 2023 16:30:21 +0000 Subject: Update note about SETUPTOOLS_ENABLE_FEATURES --- docs/userguide/development_mode.rst | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) (limited to 'docs/userguide') diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst index 6f9f5417..12d50fbc 100644 --- a/docs/userguide/development_mode.rst +++ b/docs/userguide/development_mode.rst @@ -192,16 +192,12 @@ works (still within the context of :pep:`660`). Users are encouraged to try out the new editable installation techniques and make the necessary adaptations. -If the ``compat`` mode does not work for you, you can also disable the -:pep:`editable install <660>` hooks in ``setuptools`` by setting an environment -variable: - -.. code-block:: - - SETUPTOOLS_ENABLE_FEATURES="legacy-editable" - -This *may* cause the installer (e.g. ``pip``) to effectively run the "legacy" -installation command: ``python setup.py develop`` [#installer]_. +.. note:: + Newer versions of ``pip`` no longer run the fallback command + ``python setup.py develop`` when the ``pyproject.toml`` file is present. + This means that setting the environment variable + ``SETUPTOOLS_ENABLE_FEATURES="legacy-editable"`` + will have no effect when installing a package with ``pip``. How editable installations work @@ -251,11 +247,6 @@ More information is available on the text of :pep:`PEP 660 <660#what-to-put-in-t `_ for more insights). -.. [#installer] - For this workaround to work, the installer tool needs to support legacy - editable installations. (Future versions of ``pip``, for example, may drop - support for this feature). - .. [#criteria] ``setuptools`` strives to find a balance between allowing the user to see the effects of project files being edited while still trying to keep the -- cgit v1.2.1