Add note about workaround for editable user installs via pip.

See pypa/pip#7953 and #3351
jupyter-widgets · Jan 27, 2022 · 2034ac5 · 2034ac5
1 parent 1b1a49d
commit 2034ac5
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/source/dev_install.md b/docs/source/dev_install.md
@@ -29,6 +29,15 @@ cd ipywidgets
 ./dev-install.sh
 ```
 
+### Installing with pip
+
+To do an editable install of the python ipywidgets package into the user site directory with pip, please use
+
+```bash
+pip install --prefix=$(python -m site --user-base) -e .
+```
+Using `pip install --user -e .` will not work due to a bug in pip. See https://github.com/pypa/pip/issues/7953 for more details.
+
 Rebuilding after making changes
 ----------------------------