diff options
| author | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2021-11-11 15:57:01 +0100 |
|---|---|---|
| committer | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2021-11-11 15:57:01 +0100 |
| commit | 4f475e9035ff40906024249e81b2f7e5b9bebf14 (patch) | |
| tree | c2a3b8e975fcf76305153abf021a53e28fa37afd /docs/userguide | |
| parent | 07651438d6b2086453b7f298feabb6911e5aa230 (diff) | |
| download | python-setuptools-git-4f475e9035ff40906024249e81b2f7e5b9bebf14.tar.gz | |
Document that pip works with editable setup.cfg
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/quickstart.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index bcb282ed..9c1d84f9 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -186,17 +186,17 @@ 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:: + + When there is no ``setup.py`` script present, this is only + compatible with :pep:`517` since :ref:`pip v21.1 <pip:v21-1>`. -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 . |