Skip to content

Commit b40cfb2

Browse files
committed
add note to docs and readme on installing from source
1 parent 0247bb6 commit b40cfb2

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

README.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,27 @@ The primary use cases are:
2323

2424

2525
`The documentation <https://jupyter-server-proxy.readthedocs.io/>`_
26-
contains information on installation & usage.
26+
contains information on installation & usage.
27+
28+
====================
29+
Install
30+
====================
31+
32+
pip
33+
---
34+
35+
pip install jupyter-server-proxy
36+
37+
conda
38+
-----
39+
40+
conda install jupyter-server-proxy -c conda-forge
41+
42+
src
43+
---
44+
45+
pip install .
46+
47+
**Note:** if installing from source in editable mode: ``setup.py develop/pip install -e``, please explicitly install the server extensions:
48+
49+
``jupyter serverextension enable --sys-prefix jupyter_server_proxy``

docs/install.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Jupyter Server Proxy can be installed with ``pip``. You must install
1111
pip install jupyter-server-proxy
1212
1313
14+
If using ``pip install -e`` please install the server extension explicitly:
15+
16+
.. code:: bash
17+
18+
jupyter serverextension enable --sys-prefix jupyter_server_proxy
19+
1420
If you have multiple virtualenvs or conda environments, you
1521
must install ``jupyter-server-proxy`` into the same environment
16-
your notebook is running from, rather than where your kernels are.
22+
your notebook is running from, rather than where your kernels are.

0 commit comments

Comments
 (0)