Redesign the display mechanism by Leo #528
Closed
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.
Description of proposed changes
In #269, @leouieda proposed a new design of the PyGMT display mechanism. The core idea of #269 is to have a uniform
Figure.show()
function to open images using external viewer and show images in Jupyter notebook.This is a draft implementation by @leouieda. It was done a year ago, but never finished. This is how the
Figure.show()
function in this PR behaves (the behaviors are controlled by the variableSHOW_CONFIG
):Figure.show()
open images using an external viewer and don't show the image in notebookspygmt.enable_notebook()
to disable external viewer and enable inline images in notebooksPYGMT_EXTERNAL_VIEWER
tofalse
can also disable external viewer, useful when building documentations.Recently, I'm also trying a new design (see PR #529). To me, my new design is better and more reasonable. Here, I just open this PR for more comparisons and discussions.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.