Skip to content

Commit ce9091f

Browse files
committed
various docs updates
1 parent d9bf3ac commit ce9091f

File tree

2 files changed

+12
-47
lines changed

2 files changed

+12
-47
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -94,41 +94,34 @@ conda install -c plotly plotly=5.24.1
9494

9595
### JupyterLab Support
9696

97-
For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets`
97+
For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `anywidget`
9898
packages using `pip`:
9999

100100
```
101-
pip install "jupyterlab>=3" "ipywidgets>=7.6"
101+
pip install "jupyterlab>=3" "anywidget>=0.9.13"
102102
```
103103

104104
or `conda`:
105105

106106
```
107-
conda install "jupyterlab>=3" "ipywidgets>=7.6"
108-
```
109-
110-
The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**, run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
111-
112-
```
113-
# JupyterLab 2.x renderer support
114-
jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager
107+
conda install "jupyterlab>=3" "anywidget>=0.9.13"
115108
```
116109

117110
Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
118111

119112
### Jupyter Notebook Support
120113

121-
For use in the Jupyter Notebook, install the `notebook` and `ipywidgets`
114+
For use in the Jupyter Notebook, install the `notebook` and `anywidget`
122115
packages using `pip`:
123116

124117
```
125-
pip install "notebook>=5.3" "ipywidgets>=7.5"
118+
pip install "notebook>=7.0" "anywidget>=0.9.13"
126119
```
127120

128121
or `conda`:
129122

130123
```
131-
conda install "notebook>=5.3" "ipywidgets>=7.5"
124+
conda install "notebook>=7.0" "anywidget>=0.9.13"
132125
```
133126

134127
### Static Image Export

doc/python/getting-started.md

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@ $ conda install -c plotly plotly=5.24.1
6868
```
6969
This package contains everything you need to write figures to standalone HTML files.
7070

71-
> Note: **No internet connection, account, or payment is required to use plotly.py.** Prior to version 4, this library could operate in either an "online" or "offline" mode. The documentation tended to emphasize the online mode, where graphs get published to the Chart Studio web service. In version 4, all "online" functionality was removed from the `plotly` package and is now available as the separate, optional, `chart-studio` package (See below). **plotly.py version 4 is "offline" only, and does not include any functionality for uploading figures or data to cloud services.**
72-
73-
7471
```python
7572
import plotly.express as px
7673
fig = px.bar(x=["a", "b", "c"], y=[1, 3, 2])
@@ -96,34 +93,27 @@ IFrame(snippet_url + 'getting-started', width='100%', height=1200)
9693

9794
#### JupyterLab Support
9895

99-
To use `plotly` in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets` packages in the same environment as you installed `plotly`, using `pip`:
96+
To use `plotly` in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `anywidget` packages in the same environment as you installed `plotly`, using `pip`:
10097

10198
```
102-
$ pip install "jupyterlab>=3" "ipywidgets>=7.6"
99+
pip install "jupyterlab>=3" "anywidget>=0.9.13"
103100
```
104101

105102
or `conda`:
106103

107104
```
108-
$ conda install "jupyterlab>=3" "ipywidgets>=7.6"
105+
conda install "jupyterlab>=3" "anywidget>=0.9.13"
109106
```
110107

111108
The `plotly` jupyterlab extension is included when you install `plotly` using `pip` or `conda`. When you run Jupyter Lab, ensure you are running it in the same environment that you installed `plotly` in so it has access to the `plotly` jupyterlab extension.
112109

113-
**JupyterLab 2 or earlier** does not support the prebuilt extensions installed using `pip` and `conda`. If you are using JupyterLab 2, run the following command to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
114-
115-
```
116-
# JupyterLab 2.x renderer support
117-
jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager
118-
```
119-
120110
Launch JupyterLab with:
121111

122112
```
123113
$ jupyter lab
124114
```
125115

126-
and display plotly figures inline using the `plotly_mimetype` renderer...
116+
and display plotly figures inline:
127117

128118
```python
129119
import plotly.express as px
@@ -147,20 +137,19 @@ See [_Displaying Figures in Python_](/python/renderers/) for more information on
147137
See the [Troubleshooting guide](/python/troubleshooting/) if you run into any problems with JupyterLab, particularly if you are using multiple Python environments inside Jupyter.
148138

149139

150-
151140
#### Jupyter Notebook Support
152141

153142
For use in the classic [Jupyter Notebook](https://jupyter.org/), install the `notebook` and `ipywidgets`
154143
packages using `pip`:
155144

156145
```
157-
$ pip install "notebook>=5.3" "ipywidgets>=7.5"
146+
pip install "notebook>=7.0" "anywidget>=0.9.13"
158147
```
159148

160149
or `conda`:
161150

162151
```
163-
$ conda install "notebook>=5.3" "ipywidgets>=7.5"
152+
conda install "notebook>=7.0" "anywidget>=0.9.13"
164153
```
165154

166155
These packages contain everything you need to run a Jupyter notebook...
@@ -254,23 +243,6 @@ $ conda install -c plotly plotly-geo=1.0.0
254243

255244
See [_USA County Choropleth Maps in Python_](/python/county-choropleth/) for more information on the county choropleth figure factory.
256245

257-
#### Chart Studio Support
258-
259-
The `chart-studio` package can be used to upload plotly figures to Plotly's Chart
260-
Studio Cloud or On-Prem services. This package can be installed using pip...
261-
262-
```
263-
$ pip install chart-studio==1.1.0
264-
```
265-
266-
or conda.
267-
268-
```
269-
$ conda install -c plotly chart-studio=1.1.0
270-
```
271-
272-
> **Note:** This package is optional, and if it is not installed it is not possible for figures to be uploaded to the Chart Studio cloud service.
273-
274246
### Where to next?
275247

276248
Once you've installed, you can use our documentation in three main ways:

0 commit comments

Comments
 (0)