From 1d40159e359dd323522f84d4aad7b2630b02b572 Mon Sep 17 00:00:00 2001 From: ahmadalguydi Date: Wed, 5 Aug 2026 22:27:33 +0300 Subject: [PATCH 1/4] 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 2452d9e02a3..ee0408ef2c6 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 6cdb57febf5912bcae2d4b8e094b983506b8f969 Mon Sep 17 00:00:00 2001 From: ahmadalguydi Date: Fri, 7 Aug 2026 10:22:13 +0300 Subject: [PATCH 2/4] 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 ee0408ef2c6..c6729a434a6 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. @@ -93,3 +78,18 @@ The situation is similar for environments like Nteract and Streamlit: in these e ### Orca Problems > The Orca image-generation utility is no longer supported in Plotly.py as of version 7.0.0. See the [Static Image Export page](/python/static-image-export/) for details on using Kaleido for static image generation. + +### 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. From 10961d98e80918de6d59785a74f9e31eb3adfb99 Mon Sep 17 00:00:00 2001 From: ahmadalguydi Date: Fri, 11 Sep 2026 17:02:55 +0300 Subject: [PATCH 3/4] docs: keep troubleshooting paragraph on one line --- doc/python/troubleshooting.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/doc/python/troubleshooting.md b/doc/python/troubleshooting.md index c6729a434a6..dd58eb44070 100644 --- a/doc/python/troubleshooting.md +++ b/doc/python/troubleshooting.md @@ -81,10 +81,7 @@ The situation is similar for environments like Nteract and Streamlit: in these e ### 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. +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: From 6086def3e4977001a3b6e323c61a32844025e19f Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Fri, 11 Sep 2026 09:27:09 -0600 Subject: [PATCH 4/4] Switch to alternate fence syntax --- doc/python/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/python/troubleshooting.md b/doc/python/troubleshooting.md index dd58eb44070..981b5f9fa78 100644 --- a/doc/python/troubleshooting.md +++ b/doc/python/troubleshooting.md @@ -85,8 +85,8 @@ If a figure appears blank in JupyterLab, first check that the Jupyter server env As a workaround, try the `notebook` renderer explicitly: -```python +~~~python fig.show(renderer="notebook") -``` +~~~ This can help when the default renderer does not display the figure correctly.