Use sphinx-gallery to manage examples and tutorials #268
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
leouieda
changed the title
This way, packages that depend on us can use GMT maps in their galleries
Replace the first steps notebook with a gallery tutorial
Need to finish the tutorials part
leouieda
changed the title
seisman
reviewed
Jan 24, 2019
| @@ -17,11 +22,9 @@ | |||
| "sphinx.ext.intersphinx", | |||
| "numpydoc", | |||
| "nbsphinx", | |||
There was a problem hiding this comment.
@leouieda I tried it locally. It's really nice!!!
Don't forget to remove nbsphinx, since we no longer use notebooks after this PR is merged.
There was a problem hiding this comment.
Forget it. I just saw your comments in #269.
There was a problem hiding this comment.
Thanks! I quite like it too.
I'm leaving it because I'll want to have one notebook in there as a "Using PyGMT in Jupyter" tutorial (#269).
5 tasks
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.
Description of proposed changes
Enables the usage of sphinx-gallery with PyGMT. For now, requires features that aren't yet released so we need to install from the Github master branch of sphinx-gallery. Implements an image scrapper for
pygmt.Figurethat captures them and saves to the correct file names. Need to add a global figure registry (SHOWED_FIGURESinpygmt/figure.py) so that we can request all figure objects that have called theirshowmethod. Replace the current jupyter notebooks by gallery notebook style.pyfiles, which are easier to maintain on version control.TODO: