Closed leouieda closed 3 years ago
After #268 we'll need one notebook tutorial that shows how to use PyGMT with the notebook. This can be placed in doc
and included in the toctree in doc/index.rst
. It will be converted automatically with nbsphinx.
Description of the desired feature
Currently, there many ways of displaying a PyGMT figure:
Figure.show()
in the notebook returns an IPython PNG display object for the jupyter notebookFigure
object at the end of a notebook cell displays the figure as PNGFigure.show(external=True)
will open a preview in an external PDF viewer or the browser. The external viewer is non-blocking so this doesn't work for a script.Figure.savefig(..., show=True)
will save the figure and open it on an external viewerThis is not ideal. It would be better to have:
Figure.show()
opens a preview of the figure and halts the Python process until the viewer is closed. It can also returnself
so that if it's called at the end of a notebook cell it would get displayed on the notebook as well.Figure
at the end of a notebook cell displays a PNG preview.Figure.show()
to not open the viewer. This is required when using a notebook or when building the docs (we don't want windows opening when we build the gallery or tutorials). This can be done through a functionpygmt.enable_notebook
which would set a flag to tellshow
not to do anything and/or through an environment variablePYGMT_DISPLAY
which can be set tonone
or other options that the user might want. Ideally, we should have both. The env variable will be useful when building the docs.