gh-139181: Allow translation of html_short_title in docs config #139195
+2
−1
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
StanFromIreland
requested changes
Sep 21, 2025
There was a problem hiding this comment.
Thank you, however there are several issue:
- The version number, which does not need to be translated, changes quite frequently. Just translating "Documentation" would be much easier, rather than translating every few months.
- Testing locally I see that the string is not extracted by the gettext builder, it's also not particularly clear what catalogue it's using? I tried putting it into the sphinx domain but that didn't work.
- This also breaks epub builds.
- There are also other strings that can be translated, e.g. "Python Documentation Authors".
|
Thank you for the feedback! I’ll look into these issues and see if I can fix them. Any guidance you can provide would be greatly appreciated. |
AA-Turner
added
needs backport to 3.13
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.
#139181
This PR wraps the
html_short_titlestring in conf.py with theSphinx translation function _().Please let me know if my approach or fix needs any improvements . I’m open to feedback and happy to make changes based on suggestions.
Thankyou !
📚 Documentation preview 📚: https://cpython-previews--139195.org.readthedocs.build/