Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Make figure target links relative #21887

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 1 commit into from
Dec 9, 2021
Merged

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Dec 8, 2021

PR Summary

Sphinx embeds these verbatim, so if you link to /foo, then it will go to matplotlib.org/foo, which will pop up a redirect now. Using a relative link will go directly to matplotlib.org/stable/foo.

For example, on this what's new entry, the image and the link after it should both point to the same place, but the former is at the toplevel while the latter is under stable.

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

Sphinx embeds these verbatim, so if you link to `/foo`, then it will go
to `matplotlib.org/foo`, which will pop up a redirect now. Using a
relative link will go directly to `matplotlib.org/stable/foo`.
@QuLogic QuLogic added this to the v3.5-doc milestone Dec 8, 2021
@QuLogic
Copy link
Member Author

QuLogic commented Dec 9, 2021

You can also see this happen on the devdocs and the most recent main build; since the link goes to the root, the former escapes the devdocs to the stable docs and the latter 404s.

@jklymak jklymak merged commit 738c9a9 into matplotlib:main Dec 9, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 9, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 9, 2021
dstansby added a commit that referenced this pull request Dec 9, 2021
…887-on-v3.5.0-doc

Backport PR #21887 on branch v3.5.0-doc (Make figure target links relative)
dstansby added a commit that referenced this pull request Dec 9, 2021
…887-on-v3.5.x

Backport PR #21887 on branch v3.5.x (Make figure target links relative)
@QuLogic QuLogic deleted the relative-figures branch December 9, 2021 20:20
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.

3 participants