diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-29 23:02:13 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-29 23:03:20 +0100 |
| commit | f3796a690e2c3102b732b886b54025b0e846b96d (patch) | |
| tree | f7776686379e03e849b59ed81f4ef3a0bfd093e3 | |
| parent | 85303e892eeb43314a3c1dbe75e5e9fda6980296 (diff) | |
| download | python-setuptools-git-f3796a690e2c3102b732b886b54025b0e846b96d.tar.gz | |
Document dir in strict editable installs
| -rw-r--r-- | docs/userguide/development_mode.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst index ee6b5b01..4eeb49ec 100644 --- a/docs/userguide/development_mode.rst +++ b/docs/userguide/development_mode.rst @@ -106,6 +106,15 @@ directory (``$your_project_dir/build``) and add it to ``PYTHONPATH`` via a :mod:`.pth file <site>`. (Please be careful to not delete this repository by mistake otherwise your files may stop being accessible). +.. warning:: + Strict editable installs require auxiliary files to be placed in a + ``build/__editable__.*`` directory (relative to your project root). + + Please be careful to not remove this directory while testing your project, + otherwise your editable installation may be compromised. + + You can remove the ``build/__editable__.*`` directory after uninstalling. + .. note:: .. versionadded:: v63.0.0 |