Use UTF-8 for gallery YAML files - #7993
Open
Ghraven wants to merge 1 commit into
Open
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
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.
Summary
encoding="utf-8".Problem
The docs gallery directive can load YAML from a file passed to the directive, but
Path.read_text()currently uses the platform default encoding. Gallery metadata is repo documentation content, so decoding it explicitly as UTF-8 avoids locale-dependent docs builds on Windows or other non-UTF-8 environments.Before / After
Before: gallery YAML file decoding depended on the local platform default encoding.
After: gallery YAML files are decoded as UTF-8.
Verification
python -m py_compile python/docs/src/_extension/gallery_directive.py