Fixed path bug with links in SVG inheritance diagrams#10576
Closed
ayshih wants to merge 1 commit intosphinx-doc:5.0.xfrom
Closed
Fixed path bug with links in SVG inheritance diagrams#10576ayshih wants to merge 1 commit intosphinx-doc:5.0.xfrom
ayshih wants to merge 1 commit intosphinx-doc:5.0.xfrom
Conversation
This was referenced Jun 18, 2022
Contributor
Author
|
Note that this PR fixes a bug in Sphinx that is unrelated to any use of third-party extensions (e.g., Non-exhaustive list of issues that this PR closes: #3176, sunpy/sunpy#2097, astropy/astropy#4935, probabilistic-numerics/probnum#459 Related issues:
|
This was referenced Jun 19, 2022
Closed
Contributor
Author
|
Closing this PR since #10614 is more encompassing |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
Subject: Fixes links in SVG inheritance diagrams when those diagrams are in documents not at the base level
Feature or Bugfix
Purpose
Currently, links in SVG inheritance diagrams only work when the documents are at the base level. That's because the URIs supplied to the diagram are relative to the document (as is appropriate for PNG output), but the SVGs live in the
/_imagesfolder, so the URIs need to be relative to that location. There is a hard-coded'../'that gets prepended to the URIs, which fixes only base-level documents. Documents in sub-directories result in SVG links that have one or more extraneous'../'that break the links.Detail
This PR fixes the URIs to be relative to the image directory prior to making the SVG inheritance diagrams.
Relates
Fixes #10570