diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-11-12 19:41:16 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-12 19:41:16 -0500 |
| commit | 4b980ef4072a817aae0da3643d0fa70c30fcb6cf (patch) | |
| tree | f4facf3e23f66b79899d5076026448d734b862aa /docs | |
| parent | e18db4b4bfff3b5ca70aa0a44c565a8634d65256 (diff) | |
| parent | 77678abf97b4a8ee5e6e67b14cb21f543cd6bfd9 (diff) | |
| download | python-setuptools-git-4b980ef4072a817aae0da3643d0fa70c30fcb6cf.tar.gz | |
Merge branch 'main' into prefer-svg-images
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 19 |
2 files changed, 12 insertions, 9 deletions
diff --git a/docs/conf.py b/docs/conf.py index fb497362..3cc8e35b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -196,3 +196,5 @@ icons = [ }, # rel="apple-touch-icon" does not support SVG yet ] + +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 . |