Replace :ref:sphx_glr_... by :doc:/....#11312
Merged
anntzer merged 2 commits intomatplotlib:masterfrom May 29, 2018
Merged
Conversation
2e67a84 to
233837b
Compare
jklymak
approved these changes
May 28, 2018
Member
jklymak
left a comment
There was a problem hiding this comment.
I didn't check all the links but I agree this is more readable in the source...
The latter form is shorter, not specific to sphinx-gallery, maps more cleanly to the actual path (no confusion between underscores and slashes), and links to the example page itself rather than an anchor just below it. Done by sed + manual checking.
Contributor
Author
|
Self-merging per #11312 (review). |
|
There seem to be a conflict, please backport manually |
tacaswell
pushed a commit
to tacaswell/matplotlib
that referenced
this pull request
Aug 4, 2018
This also backported parts of other PRs making changes to the docs.
Replace :ref:`sphx_glr_...` by :doc:`/...`.
Conflicts:
examples/color/color_cycler.py
- deleted, not present on 2.2.x
examples/axes_grid1/simple_anchored_artists.py
examples/images_contours_and_fields/contour_image.py
examples/images_contours_and_fields/quiver_demo.py
examples/images_contours_and_fields/quiver_simple_demo.py
examples/misc/anchored_artists.py
- keep master version
Member
|
backported to v2.2.x as e5ce40b |
This was referenced Aug 26, 2018
Closed
6 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The latter form is shorter, not specific to sphinx-gallery, maps more
cleanly to the actual path (no confusion between underscores and
slashes), and links to the example page itself rather than an anchor
just below it.
(Compare for example https://matplotlib.org/devdocs/tutorials/colors/colors.html#sphx-glr-tutorials-colors-colors-py where the top is chopped off by the top banner and one needs to scroll up, vs https://matplotlib.org/devdocs/tutorials/colors/colors.html)
Done by sed + manual checking.
PR Summary
PR Checklist