Skip to content

Commit 0cf7c4a

Browse files
authored
Update installation.rst for JupyterLab 3.0
1 parent 8a4d12a commit 0cf7c4a

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

docs/getting_started/installation.rst

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,41 +9,64 @@ JupyterLab >= 2.0
99

1010
Install
1111
~~~~~~~
12-
Note: You will need NodeJS to install the extension.
12+
For JupyterLab 3+:
1313

1414
.. code:: bash
1515
1616
pip install jupyterlab-interactive-dashboard-editor
17+
18+
For JupyterLab 2.x:
19+
20+
.. code:: bash
21+
22+
jupyter labextension install jupyterlab-interactive-dashboard-editor
1723
jupyter lab build
1824
25+
Note: You will need NodeJS to install the extension for JupyterLab 2.x.
26+
27+
Developement install:
28+
1929
.. code:: bash
2030
2131
# Clone the repo to your local environment
2232
# Move to jupyterlab-interactive-dashboard-editor directory
2333
24-
# Install dependencies
25-
jlpm
26-
# Build Typescript source
27-
jlpm build
34+
# Clone the repo to your local environment
35+
# Change directory to the {{ cookiecutter.python_name }} directory
36+
# Install package in development mode
37+
pip install -e .
2838
# Link your development version of the extension with JupyterLab
29-
jupyter labextension install .
30-
# Rebuild Typescript source after making changes
31-
jlpm build
32-
# Rebuild JupyterLab after making any changes
33-
jupyter lab build
39+
jupyter labextension develop . --overwrite
40+
# Rebuild extension Typescript source after making changes
41+
jlpm run build
42+
3443
35-
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
44+
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
3645

3746
.. code:: bash
3847
39-
# Watch the source directory in another terminal tab
40-
jlpm watch
41-
# Run jupyterlab in watch mode in one terminal tab
42-
jupyter lab --watch
48+
# Watch the source directory in one terminal, automatically rebuilding when needed
49+
jlpm run watch
50+
# Run JupyterLab in another terminal
51+
jupyter lab
52+
53+
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
54+
55+
By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
56+
57+
.. code:: bash
58+
jupyter lab build --minimize=False
4359
44-
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
4560
4661
Uninstall
4762
~~~~~~~~~
63+
64+
For JupyterLab 3+:
65+
66+
.. code:: bash
67+
pip uninstall jupyterlab-interactive-dashboard-editor
68+
69+
For JupyterLab 2.x:
70+
4871
.. code:: bash
49-
jupyter labextension uninstall jupyterlab-interactive-dashboard-editor
72+
jupyter labextension uninstall jupyterlab-interactive-dashboard-editor

0 commit comments

Comments
 (0)