Skip to content

Fix non existent URI s #19793

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
Mar 28, 2021
Merged

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Mar 27, 2021

PR Summary

Fixes #19780. @anntzer actually wrote the code, so perhaps he has a more elegant solution...

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@anntzer
Copy link
Contributor

anntzer commented Mar 27, 2021

I think(?) the correct fix is more something like

diff --git i/doc/sphinxext/redirect_from.py w/doc/sphinxext/redirect_from.py
index ff3826056..01ab484ce 100644
--- i/doc/sphinxext/redirect_from.py
+++ w/doc/sphinxext/redirect_from.py
@@ -65,8 +65,7 @@ class RedirectFrom(Directive):
             raise ValueError(
                 f"{redirected_reldoc} is already noted as redirecting to "
                 f"{self.redirects[redirected_reldoc]}")
-        self.redirects[redirected_reldoc] = builder.get_relative_uri(
-            redirected_reldoc, current_doc)
+        self.redirects[redirected_reldoc] = current_doc
         return []
 
 
@@ -76,7 +75,7 @@ def _generate_redirects(app, exception):
         return
     for k, v in RedirectFrom.redirects.items():
         p = Path(app.outdir, k + builder.out_suffix)
-        html = HTML_TEMPLATE.format(v=v)
+        html = HTML_TEMPLATE.format(v=builder.get_relative_uri(k, v))
         if p.is_file():
             if p.read_text() != html:
                 logger.warning(f'A redirect-from directive is trying to '

so that e.g. make latexpdf; make html works as well (the first make will still record the right info that lets the second one just directly generate the redirects).

@jklymak jklymak force-pushed the fix-non-existent-URIs branch from aa98720 to 9168a84 Compare March 28, 2021 00:07
@timhoffm timhoffm added this to the v3.4-doc milestone Mar 28, 2021
@timhoffm timhoffm merged commit e6fd901 into matplotlib:master Mar 28, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Mar 28, 2021

Something went wrong ... Please have a look at my logs.

@QuLogic
Copy link
Member

QuLogic commented Mar 29, 2021

@meeseeksdev backport to v3.4.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 29, 2021
@QuLogic QuLogic modified the milestones: v3.4-doc, v3.4.1 Mar 29, 2021
QuLogic added a commit that referenced this pull request Mar 30, 2021
…793-on-v3.4.x

Backport PR #19793 on branch v3.4.x (Fix non existent URI s)
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.

redirect_from extension breaks latex build
4 participants