-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add Contributing section about gallery examples #905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4227ff8
add section about gallery examples to contributing guide
kandersolar 7868fd7
Merge remote-tracking branch 'upstream/master' into example_docs
kandersolar 80ab40b
Merge remote-tracking branch 'upstream/master' into example_docs
kandersolar 01b4e39
whatsnew
kandersolar f34fb22
whatsnew cleanup
kandersolar 975e6bb
add review suggestion
kandersolar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think what's happening is that
sphinx-gallerygenerates intermediate.rstfiles from the example scripts and puts them insphinx/source/auto_examples, making them look just like normal RST source files. When sphinx itself runs, it doesn't realize those files were just auto-generated a moment ago and so it creates "edit on github" links assuming that those RST files exist on GH as well.Looks like it isn't a trivial fix to make the links point to the original .py files -- MetPy handles it with a custom template: Unidata/MetPy@8f1783a. If nobody is eager, I'll volunteer to try to get it working in a separate PR.