transmute: enforce render_dot file to str type#1088
Merged
Conversation
Old `render_dot` returned a `str` but Sphinx v8.2 comes with a wrapper to prepare for the type changing to a `Path` type. Sphinx's usage of `render_dot` will generate a file type and use it in the translator, but this extension replaces the node here with a compatible `nodes.image` type ahead of time (e.g. for asset processing). The `nodes.image` type expects a `str` type, so convert ensure any new Path-like type is converted back to a `str` to prevent issues. Signed-off-by: James Knight <git@jdknight.me>
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 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.
Old
render_dotreturned astrbut Sphinx v8.2 comes with a wrapper to prepare for the type changing to aPathtype. Sphinx's usage ofrender_dotwill generate a file type and use it in the translator, but this extension replaces the node here with a compatiblenodes.imagetype ahead of time (e.g. for asset processing). Thenodes.imagetype expects astrtype, so convert ensure any new Path-like type is converted back to astrto prevent issues.