Skip to content

gh-139181: Allow translation of html_short_title in docs config #139195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

gh-139181: Allow translation of html_short_title in docs config #139195

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c2e43d
Allow translation of html_short_title in docs config
Aniketsy Sep 21, 2025
2e70a19
Mark epub_author and epub_publisher for translation
Aniketsy Sep 22, 2025
16af148
Mark epub_author and epub_publisher for translation
Aniketsy Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

# Python specific content from Doc/Tools/extensions/pyspecific.py
from pyspecific import SOURCE_URI
from sphinx.locale import _

# General configuration
# ---------------------
Expand Down Expand Up @@ -299,7 +300,7 @@
print("It may be removed in the future\n")

# Short title used e.g. for <title> HTML tags.
html_short_title = f'{release} Documentation'
html_short_title = _('%(release)s Documentation') % {'release': release}

# Deployment preview information
# (See .readthedocs.yml and https://docs.readthedocs.io/en/stable/reference/environment-variables.html)
Expand Down Expand Up @@ -446,8 +447,8 @@
# Options for Epub output
# -----------------------

epub_author = 'Python Documentation Authors'
epub_publisher = 'Python Software Foundation'
epub_author = _('Python Documentation Authors')
epub_publisher = _('Python Software Foundation')
Comment on lines +450 to +451
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is failing with:

WARNING: The config value `epub_author' has type `_TranslationProxy'; expected `str'.
WARNING: The config value `epub_publisher' has type `_TranslationProxy'; expected `str'.

Does Sphinx need an update for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m not entirely sure about this. I added the changes based on a suggestion, but if they’re not required, I can remove them.
@StanFromIreland Could you please confirm whether these changes are actually needed ?

epub_exclude_files = ('index.xhtml', 'download.xhtml')

# index pages are not valid xhtml
Expand Down
Loading