Skip to content

Commit

Permalink
docs(plotly): Add warning about plotly/nbformat issue (#527)
Browse files Browse the repository at this point in the history
Closes #500

Co-authored-by: Camille Troillard <[email protected]>
  • Loading branch information
augustebaum and tuscland authored Oct 18, 2024
1 parent bae4fff commit 1848c4e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
11 changes: 10 additions & 1 deletion examples/01_basic_usage.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,16 @@
"id": "47",
"metadata": {},
"source": [
"Plotly figures:"
"Plotly figures:\n",
"\n",
"> NOTE: Some users reported the following error when running the Plotly cells:\n",
"> ```\n",
"> ValueError: Mime type rendering requires nbformat>=4.2.0 but it is not installed\n",
"> ```\n",
"> This is a Plotly issue which is documented [here](https://github.com/plotly/plotly.py/issues/3285); to solve it, we recommend installing nbformat in your environment, e.g. with\n",
"> ```sh\n",
"> pip install --upgrade nbformat\n",
"> ```"
]
},
{
Expand Down
11 changes: 10 additions & 1 deletion examples/01_basic_usage.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# extension: .py
# format_name: percent
# format_version: '1.3'
# jupytext_version: 1.16.4
# jupytext_version: 1.16.2
# kernelspec:
# display_name: .venv
# language: python
Expand Down Expand Up @@ -260,6 +260,15 @@ def my_func(x):

# %% [markdown]
# Plotly figures:
#
# > NOTE: Some users reported the following error when running the Plotly cells:
# > ```
# > ValueError: Mime type rendering requires nbformat>=4.2.0 but it is not installed
# > ```
# > This is a Plotly issue which is documented [here](https://github.com/plotly/plotly.py/issues/3285); to solve it, we recommend installing nbformat in your environment, e.g. with
# > ```sh
# > pip install --upgrade nbformat
# > ```

# %%
df = px.data.iris()
Expand Down

0 comments on commit 1848c4e

Please sign in to comment.