From 608e304df76615d9253b115cdcff4d735b6f33cc Mon Sep 17 00:00:00 2001 From: kngwyu Date: Fri, 24 Jun 2022 19:06:33 +0900 Subject: [Docs] Add two footnotes about editable install ... for editable install with pyproject.toml --- docs/userguide/pyproject_config.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'docs') 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 `. + For the time being [#pep660-status]_, ``pip`` still might require a ``setup.py`` file + to support :doc:`editable installs ` [#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 -- cgit v1.2.1 From d0774bc3e979986f1c72a06b7640c993dc29c2e4 Mon Sep 17 00:00:00 2001 From: kngwyu Date: Mon, 4 Jul 2022 20:25:00 +0900 Subject: [Docs] Fix a note about PEP660 status --- docs/userguide/pyproject_config.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index c3977d13..c13eb1f0 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -212,8 +212,7 @@ 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. + ``setuptools >= 64.0.0``. 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 -- cgit v1.2.1 From e66543497e697e707e4f523b0ffbf58dc2fa2525 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Sat, 6 Aug 2022 19:10:48 +0100 Subject: docs: Avoid mentioning version 64 directly, as the exact version may change --- docs/userguide/pyproject_config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index c13eb1f0..a40655c6 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -211,8 +211,8 @@ 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 >= 64.0.0``. Check https://github.com/pypa/setuptools/issues/2816 for detail. +.. [#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 -- cgit v1.2.1 From 6e042281e7add1fae30e5cbaf51fc57430a9547e Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Sat, 6 Aug 2022 19:12:53 +0100 Subject: docs: Rephrase foot note --- docs/userguide/pyproject_config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index a40655c6..8e50eb9d 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -216,7 +216,7 @@ however please keep in mind that all non-comment lines must conform with :pep:`5 .. [#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. + 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 -- cgit v1.2.1