Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #956

Merged
merged 1 commit into from
Apr 5, 2022
Merged

Update installation instructions #956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ pip install -e .
If you are using the classic Jupyter Notebook you need to install the nbextension:

```
jupyter nbextension install --py --symlink --sys-prefix ipyleaflet
jupyter nbextension enable --py --sys-prefix ipyleaflet
jupyter nbextension install --py --symlink --sys-prefix --overwrite ipyleaflet
jupyter nbextension enable --py --sys-prefix --overwrite ipyleaflet
```

Note for developers:
Expand Down
21 changes: 9 additions & 12 deletions docs/source/installation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,20 @@ If you have JupyterLab <=2, you will also need to install the JupyterLab extensi
Development installation
------------------------

For a development installation (requires npm):
For a development installation (requires yarn):

.. code:: bash

git clone https://github.com/jupyter-widgets/ipyleaflet.git
cd ipyleaflet
pip install -e .
jupyter nbextension install --py --symlink --sys-prefix ipyleaflet
jupyter nbextension enable --py --sys-prefix ipyleaflet
jupyter labextension install @jupyter-widgets/jupyterlab-manager js # If you are developing on JupyterLab

# If you are developing on Jupyter Notebook
jupyter nbextension install --py --symlink --sys-prefix --overwrite ipyleaflet
jupyter nbextension enable --py --sys-prefix --overwrite ipyleaflet

# If you are developing on JupyterLab
jupyter labextension develop . --overwrite

Note for developers:

Expand All @@ -48,12 +52,5 @@ Note for developers:

.. code:: bash

npm run watch

If you are on JupyterLab you also need to run the following in a separate terminal:

.. code:: bash

jupyter lab --watch
yarn run watch

Every time a JavaScript build has terminated you need to refresh the Notebook page in order to load the JavaScript code again.