EmbedAPI: clean images (src) properly from inside a tooltip
#9337
Conversation
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
- rename `clean_links` as `clean_references` - rename `URLData.href` as `URLData.ref` This is done because this function will clean `a.href` and also `img.src` now.
When returning the content to be injected in a tooltip, besides cleaning the `a.href` we are also cleaning the `img.src` to make them absolute and render the images properly. See readthedocs/sphinx-hoverxref#200
humitos
changed the title
src) properly from inside a tooltip
These `src=` fields are not cleaned by `clean_references`.
ericholscher
approved these changes
Jun 16, 2022
| """ | ||
| Rewrite (internal) links to make them absolute. | ||
| Rewrite (internal) links (href) and images (src) to make them absolute. |
There was a problem hiding this comment.
I wonder if there's other external things we want to be rewriting here as well?
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/source is one example, perhaps.
There was a problem hiding this comment.
I created #9344 to track this and improve the API with other cases that may require rewriting the HTML content.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When returning the content to be injected in a tooltip, besides cleaning the
a.hrefwe are also cleaning theimg.srcto make them absolute and render theimages properly.
Working example
See readthedocs/sphinx-hoverxref#200