diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-11-14 17:41:08 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-14 17:41:08 -0500 |
| commit | 5b75de07169ef13952a5ab48e0b8bc15f31d0c37 (patch) | |
| tree | 13b02b20c66d6f5fca7905285ee609a5ad72acb6 /docs/userguide/quickstart.rst | |
| parent | 6fc5d3099898fc3d06bcf72f1f6607d02124d60f (diff) | |
| parent | 5141c4210c2a63a3bb54f0f512e4116faedc8d63 (diff) | |
| download | python-setuptools-git-debt/remove-legacy-version.tar.gz | |
Merge branch 'main' into debt/remove-legacy-versiondebt/remove-legacy-version
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 . |