From fd4d304f447d8df2525576060296b71d0d723db3 Mon Sep 17 00:00:00 2001 From: ahmadalguydi Date: Wed, 5 Aug 2026 22:27:33 +0300 Subject: [PATCH 1/2] docs: add Jupyter blank-render troubleshooting --- doc/python/troubleshooting.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/python/troubleshooting.md b/doc/python/troubleshooting.md index 09c274e3e60..75652fa0929 100644 --- a/doc/python/troubleshooting.md +++ b/doc/python/troubleshooting.md @@ -35,6 +35,21 @@ jupyter: --- +### Jupyter and JupyterLab Problems + +If a figure appears blank in JupyterLab, first check that the Jupyter server +environment and the environment used by the notebook kernel can both access the +Plotly packages they need. This is especially important when JupyterLab and +`plotly` are installed in separate virtual environments. + +As a workaround, try the `notebook` renderer explicitly: + +```python +fig.show(renderer="notebook") +``` + +This can help when the default renderer does not display the figure correctly. + ### Version Problems In order to follow the examples in this documentation site, you should have the latest version of `plotly` installed (5.x), as detailed in the [Getting Started](/python/getting-started) guide. This documentation (under https://plotly.com/python) is compatible with `plotly` version 4.x but *not* with version 3.x, for which the documentation is available under https://plotly.com/python/v3. In general you must also have the correct version of the underlying Plotly.js rendering engine installed, and the way to do that depends on the environment in which you are rendering figures: Dash, Jupyter Lab or Classic Notebook, VSCode etc. Read on for details about troubleshooting `plotly` in these environments. From 846b3674c7146073e47cac2f616118b5054962ef Mon Sep 17 00:00:00 2001 From: ahmadalguydi Date: Fri, 7 Aug 2026 10:22:13 +0300 Subject: [PATCH 2/2] docs: move Jupyter troubleshooting section --- doc/python/troubleshooting.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/python/troubleshooting.md b/doc/python/troubleshooting.md index 75652fa0929..620de620e57 100644 --- a/doc/python/troubleshooting.md +++ b/doc/python/troubleshooting.md @@ -35,21 +35,6 @@ jupyter: --- -### Jupyter and JupyterLab Problems - -If a figure appears blank in JupyterLab, first check that the Jupyter server -environment and the environment used by the notebook kernel can both access the -Plotly packages they need. This is especially important when JupyterLab and -`plotly` are installed in separate virtual environments. - -As a workaround, try the `notebook` renderer explicitly: - -```python -fig.show(renderer="notebook") -``` - -This can help when the default renderer does not display the figure correctly. - ### Version Problems In order to follow the examples in this documentation site, you should have the latest version of `plotly` installed (5.x), as detailed in the [Getting Started](/python/getting-started) guide. This documentation (under https://plotly.com/python) is compatible with `plotly` version 4.x but *not* with version 3.x, for which the documentation is available under https://plotly.com/python/v3. In general you must also have the correct version of the underlying Plotly.js rendering engine installed, and the way to do that depends on the environment in which you are rendering figures: Dash, Jupyter Lab or Classic Notebook, VSCode etc. Read on for details about troubleshooting `plotly` in these environments. @@ -97,3 +82,18 @@ The situation is similar for environments like Nteract and Streamlit: in these e If you get an error message stating that the `orca` executable that was found is not valid, this may be because another executable with the same name was found on your system. Please specify the complete path to the Plotly-Orca binary that you downloaded (for instance in the Miniconda folder) with the following command: `plotly.io.orca.config.executable = '/home/your_name/miniconda3/bin/orca'` + +### Jupyter and JupyterLab Problems + +If a figure appears blank in JupyterLab, first check that the Jupyter server +environment and the environment used by the notebook kernel can both access the +Plotly packages they need. This is especially important when JupyterLab and +`plotly` are installed in separate virtual environments. + +As a workaround, try the `notebook` renderer explicitly: + +```python +fig.show(renderer="notebook") +``` + +This can help when the default renderer does not display the figure correctly.