Skip to content

Replace :ref:sphx_glr_... by :doc:/.... #11312

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 2 commits into from
May 29, 2018
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented May 26, 2018

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

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer force-pushed the rerefs branch 2 times, most recently from 2e67a84 to 233837b Compare May 27, 2018 11:08
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't check all the links but I agree this is more readable in the source...

@tacaswell tacaswell added this to the v2.2.3 milestone May 29, 2018
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a rebase

@anntzer can self-merge conditional on CI passing.

anntzer added 2 commits May 28, 2018 23:06
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.
@anntzer
Copy link
Contributor Author

anntzer commented May 29, 2018

Self-merging per #11312 (review).

@anntzer anntzer merged commit 2465e60 into matplotlib:master May 29, 2018
@anntzer anntzer deleted the rerefs branch May 29, 2018 06:51
@lumberbot-app
Copy link

lumberbot-app bot commented May 29, 2018

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
@tacaswell
Copy link
Member

backported to v2.2.x as e5ce40b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants