Fix missing PyGMT images in user guide #474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use `fig.show(method="notebook")` in user guide pages that use PyGMT to generate plots. This way `jupyter-sphinx` is able to render the images in the generated HTML files.
leouieda
previously requested changes
Mar 13, 2024
There was a problem hiding this comment.
Until there is a fix on the PyGMT side, I'd recommend adding this cell to the top of the files (after the imports):
.. jupyter-execute::
:hide-code:
# Needed so that displaying works on jupyter-sphinx and sphinx-gallery at
# the same time. Using PYGMT_USE_EXTERNAL_DISPLAY="false" in the Makefile
# for sphinx-gallery to work means that fig.show won't display anything here
# either.
pygmt.set_display(method="notebook")
This way the code works on notebooks and terminal (setting method="notebook" doesn't). And when there is a fix, this won't change anything.
|
I totally agree. That's a much better solution than this one. I'll revert the previous changes and then apply the one you suggested. |
This reverts commit 7cd0ba8.
Add a hidden cell in user guides that make use of PyGMT to plot maps. This cell configures PyGMT display method to `"notebook"` in order to fix the issue of missing figures in our docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add hidden cell in user guide examples configuring PyGMT to use
"notebook"as display method. This wayjupyter-sphinxis able to render the images in the generated HTML files. This issue should be fixed upstream in PyGMT.Relevant issues/PRs:
Fixes #473