ENH: Directly add SVG instead of linking via IMG #161
Merged
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
choldgraf
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR modifies the way that we insert copy buttons into the code blocks, so that we directly insert the SVG into the DOM, rather than linking to one via the
<img>tag. This allows users to style the color of the copy button icon, which is particularly useful for things like "dark mode".try it out here 👉 https://readthedocs.org/projects/sphinx-copybutton/builds/15979421/
For example, here's the copy button's current behavior with Furo:
And the new behavior:
Modifying the copy icon now means directly pasting in some SVG code to your
conf.pyfile, rather than specifying a path to an image file. This oldcopybutton_image_pathwill go through a deprecation cycle.