Skip to content

docs: explain Jupyter blank-render workaround - #5692

Merged
camdecoster merged 4 commits into
plotly:mainfrom
tomatotomata:codex/document-jupyter-renderer-fallback
Sep 11, 2026
Merged

docs: explain Jupyter blank-render workaround#5692
camdecoster merged 4 commits into
plotly:mainfrom
tomatotomata:codex/document-jupyter-renderer-fallback

Conversation

@tomatotomata

Copy link
Copy Markdown
Contributor

What changed

I added a short Jupyter and JupyterLab troubleshooting section to the existing troubleshooting page. It calls out the separate-server and kernel environment setup, then documents the fig.show(renderer=notebook) workaround from #5664.

This is intentionally documentation only. It does not claim to fix the underlying blank-render bug.

Validation

  • git diff --check passed
  • The repository's docs conversion tool was not available locally, so the full notebook build was not run

This follows the scope suggested in #5664. Let me know what you think.

Closes #5664

@camdecoster camdecoster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! This will be a helpful addition. Could you please move this section to the end of the document?

Comment thread doc/python/troubleshooting.md Outdated
Comment on lines +40 to +43
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@tomatotomata

Copy link
Copy Markdown
Contributor Author

I moved the Jupyter and JupyterLab section to the end of doc/python/troubleshooting.md in 846b3674c. The content is unchanged, so the page now follows the ordering you requested without widening the scope. git diff --check is clean. Let me know what you think.

Comment thread doc/python/troubleshooting.md Outdated
Comment on lines +88 to +91
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please update this to all be on one line? That matches the style of the document.

@tomatotomata

Copy link
Copy Markdown
Contributor Author

I updated the troubleshooting paragraph in bb4dd0b24 so the sentence stays on one line, matching the document style. git diff --check passes. Let me know what you think.

@tomatotomata
tomatotomata force-pushed the codex/document-jupyter-renderer-fallback branch from bb4dd0b to 10961d9 Compare September 11, 2026 14:31
@tomatotomata

Copy link
Copy Markdown
Contributor Author

I also rebased the PR onto current main at 304fb763e, keeping its current Orca wording and the requested one-line Jupyter troubleshooting paragraph. The refreshed head is 10961d98e; git diff --check passes, and GitHub now reports the PR as mergeable again. The Orca security check is queued on this head. Let me know what you think.

camdecoster
camdecoster previously approved these changes Sep 11, 2026
@camdecoster camdecoster added the no-changelog A changelog entry is not required for this PR label Sep 11, 2026
@camdecoster
camdecoster merged commit 2e2d1f0 into plotly:main Sep 11, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog A changelog entry is not required for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: Blank plot in Jupyterlab when plotly is installed in different virtual env from jupyter server

2 participants