Skip to content

docs: explain Jupyter blank-render workaround #5692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomatotomata wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

docs: explain Jupyter blank-render workaround #5692

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/python/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,21 @@ jupyter:
---

<!-- #region -->
### 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.
Expand Down