diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-11-12 18:25:56 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-12 18:25:56 -0500 |
| commit | 8c3aa8400947d633d93dda6a7c7633a17f154a4a (patch) | |
| tree | 662479fa8a0f62f438bde038c3cbe530986d3510 /docs/userguide/quickstart.rst | |
| parent | 8ab7799032fd7811c55388ce04df90e486370106 (diff) | |
| parent | ba39e1851f02fa27b425f616d13c2b07298c63d5 (diff) | |
| download | python-setuptools-git-8c3aa8400947d633d93dda6a7c7633a17f154a4a.tar.gz | |
Merge pull request #2871 from webknjaz/maintenance/docs-pip-editable-v21.1
Document that pip works with editable `setup.cfg`
Diffstat (limited to 'docs/userguide/quickstart.rst')
| -rw-r--r-- | docs/userguide/quickstart.rst | 19 |
1 files changed, 10 insertions, 9 deletions
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 . |