diff options
| -rw-r--r-- | changelog.d/2871.doc.rst | 4 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 19 |
3 files changed, 16 insertions, 9 deletions
diff --git a/changelog.d/2871.doc.rst b/changelog.d/2871.doc.rst new file mode 100644 index 00000000..2a099d0d --- /dev/null +++ b/changelog.d/2871.doc.rst @@ -0,0 +1,4 @@ +Added a note to the docs that it is possible to install +``setup.py``-less projects in editable mode with :doc:`pip v21.1+ +<pip:index>`, only having ``setup.cfg`` and ``pyproject.toml`` in +project root -- by :user:`webknjaz` diff --git a/docs/conf.py b/docs/conf.py index ebb84c48..d352a481 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,3 +171,5 @@ towncrier_draft_working_directory = '..' towncrier_draft_include_empty = False extensions += ['jaraco.tidelift'] + +intersphinx_mapping['pip'] = 'https://pip.pypa.io/en/latest', None diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index bcb282ed..6bf353a0 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -186,17 +186,18 @@ For more details, see :doc:`datafiles` Development mode ================ -``setuptools`` allows you to install a package without copying any files -to your interpreter directory (e.g. the ``site-packages`` directory). This -allows you to modify your source code and have the changes take effect without -you having to rebuild and reinstall. This is currently incompatible with -PEP 517 and therefore it requires a ``setup.py`` script with the following -content:: - import setuptools - setuptools.setup() +.. tip:: + + Prior to :ref:`pip v21.1 <pip:v21-1>`, a ``setup.py`` script was + required to be compatible with development mode. With late + versions of pip, any project may be installed in this mode. -Then:: +``setuptools`` allows you to install a package without copying any files +to your interpreter directory (e.g. the ``site-packages`` directory). +This allows you to modify your source code and have the changes take +effect without you having to rebuild and reinstall. +Here's how to do it:: pip install --editable . |