Skip to content

Commit d20967b

Browse files
committed
Update docs
Signed-off-by: martinRenou <[email protected]>
1 parent 083631e commit d20967b

File tree

2 files changed

+5
-43
lines changed

2 files changed

+5
-43
lines changed

.travis.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ install:
2121
- conda config --set always_yes yes --set changeps1 no
2222
- conda update -q conda
2323
- conda info -a
24-
- conda install -c conda-forge nodejs=13 notebook matplotlib ipywidgets jupyterlab
25-
- pip install -v .
24+
- conda install -c conda-forge nodejs=13 matplotlib
25+
- conda install jupyterlab=3 ipywidgets jupyterlab_widgets -c conda-forge/label/jupyterlab_rc -c conda-forge/label/jupyterlab_server_rc -c conda-forge/label/jupyterlab_widgets_rc
26+
- pip install .
2627
script:
2728
- test -d $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib
2829
- test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib/extension.js

README.md

Lines changed: 2 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -39,48 +39,9 @@ conda install -c conda-forge ipympl
3939
pip install ipympl
4040
```
4141

42-
### Install the JupyterLab extension
42+
### Use in JupyterLab
4343

44-
In order to install the JupyterLab extension `jupyter-matplotlib`, you will first need to install `nodejs`, you can install it with `conda` doing
45-
46-
```bash
47-
conda install -c conda-forge nodejs
48-
```
49-
50-
Starting from ipympl `0.5.6`, **you do not need to manually install the JupyterLab extension**, but you still need to install the JupyterLab widget manager:
51-
```bash
52-
jupyter labextension install @jupyter-widgets/jupyterlab-manager
53-
54-
# If you already installed the @jupyter-widgets/jupyterlab-manager extension, you will still need to rebuild JupyterLab after you installed ipympl
55-
jupyter lab build
56-
```
57-
58-
#### Install an old JupyterLab extension
59-
60-
You will need to install the right `jupyter-matplotlib` version, according to the `ipympl` and `jupyterlab` versions you installed.
61-
For example, if you installed ipympl `0.5.1`, you need to install jupyter-matplotlib `0.7.0`, and this version is only compatible with JupyterLab `1`.
62-
63-
```bash
64-
conda install -c conda-forge ipympl==0.5.1
65-
jupyter labextension install @jupyter-widgets/jupyterlab-manager [email protected]
66-
```
67-
68-
Versions lookup table:
69-
70-
71-
| `ipympl` | `jupyter-matplotlib` | `JupyterLab` | `Matplotlib` |
72-
|----------|----------------------|--------------|--------------|
73-
| 0.5.8 | 0.7.4 | 1 or 2 | 3.3.1 |
74-
| 0.5.7 | 0.7.3 | 1 or 2 | 3.2.* |
75-
| ... | ... | ... | |
76-
| 0.5.3 | 0.7.2 | 1 or 2 | |
77-
| 0.5.2 | 0.7.1 | 1 | |
78-
| 0.5.1 | 0.7.0 | 1 | |
79-
| 0.5.0 | 0.6.0 | 1 | |
80-
| 0.4.0 | 0.5.0 | 1 | |
81-
| 0.3.3 | 0.4.2 | 1 | |
82-
| 0.3.2 | 0.4.1 | 1 | |
83-
| 0.3.1 | 0.4.0 | 0 or 1 | |
44+
If you want to use ipympl in JupyterLab, we recommend using JupyterLab >= 3.
8445

8546
### For a development installation (requires nodejs):
8647

0 commit comments

Comments
 (0)