Skip to content

Enable theme translation #246

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 3 additions & 6 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ jobs:
pip install -r requirements.txt
- name: Remove locale file for testing
shell: bash
run: rm -rf locales/pt_BR/
run: rm -rf python_docs_theme/locales/pt_BR/
- run: python babel_runner.py extract
- run: python babel_runner.py init -l pt_BR
- run: python babel_runner.py update
Expand All @@ -80,10 +80,7 @@ jobs:
- run: python babel_runner.py compile -l pt_BR
- name: Print .pot file
shell: bash
run: cat locales/messages.pot
run: cat python_docs_theme/locales/messages.pot
- name: Print .po file
shell: bash
run: cat locales/pt_BR/LC_MESSAGES/messages.po
- name: list files in locales dir
shell: bash
run: ls -R locales/
run: cat python_docs_theme/locales/pt_BR/LC_MESSAGES/messages.po
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ coverage.xml
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
Expand Down
6 changes: 3 additions & 3 deletions babel_runner.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/venv python3
#!/usr/bin/env python3
"""Script for handling translations with Babel"""
from __future__ import annotations

Expand All @@ -15,9 +15,9 @@
# Global variables used by pybabel below (paths relative to PROJECT_DIR)
DOMAIN = "messages"
COPYRIGHT_HOLDER = "Python Software Foundation"
LOCALES_DIR = "locales"
POT_FILE = Path(LOCALES_DIR, f"{DOMAIN}.pot")
SOURCE_DIR = "python_docs_theme"
LOCALES_DIR = f"{SOURCE_DIR}/locales"
POT_FILE = Path(LOCALES_DIR, f"{DOMAIN}.pot")
MAPPING_FILE = ".babel.cfg"


Expand Down
14 changes: 14 additions & 0 deletions python_docs_theme/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import gettext
from pathlib import Path

TYPE_CHECKING = False
Expand All @@ -12,9 +13,22 @@
THEME_PATH = Path(__file__).resolve().parent


def setup_translations(app):
translation = gettext.translation(
domain="messages",
localedir=os.fspath(THEME_PATH / "locales"),
languages=[app.config.language],
fallback=True,
)
app.builder.templates.environment.install_gettext_translations(
translation, newstyle=True
)


def setup(app: Sphinx) -> ExtensionMetadata:
app.require_sphinx("7.3")

app.connect("builder-inited", setup_translations)
app.add_html_theme("python_docs_theme", str(THEME_PATH))

return {
Expand Down
Binary file not shown.
127 changes: 127 additions & 0 deletions python_docs_theme/locales/pl_PL/LC_MESSAGES/messages.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Polish (Poland) translations for python-docs-theme.
# Copyright (C) 2025 Python Software Foundation
# This file is distributed under the same license as the python-docs-theme
# project.
# Stan Ulbrych, 2025.
#
msgid ""
msgstr ""
"Project-Id-Version: python-docs-theme 2025.5\n"
"Report-Msgid-Bugs-To: https://github.com/python/python-docs-theme/issues\n"
"POT-Creation-Date: 2025-08-07 19:09+0200\n"
"PO-Revision-Date: 2025-08-07 15:11+0200\n"
"Last-Translator: Stan Ulbrych \n"
"Language: pl_PL\n"
"Language-Team: pl_PL <LL@li.org>\n"
"Plural-Forms: nplurals=3; plural=(n==1 ? 0 : n%10>=2 && n%10<=4 && "
"(n%100<10 || n%100>=20) ? 1 : 2);\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.16.0\n"

#: python_docs_theme/footerdonate.html:1
msgid "The Python Software Foundation is a non-profit corporation."
msgstr "Python Software Foundation jest organizacją non-profit."

#: python_docs_theme/footerdonate.html:2
msgid "Please donate."
msgstr "Prosimy o wsparcie."

#: python_docs_theme/layout.html:6
msgid "Navigation"
msgstr "Nawigacja"

#: python_docs_theme/layout.html:51 python_docs_theme/layout.html:111
msgid "Quick search"
msgstr "Szybkie wyszukiwanie"

#: python_docs_theme/layout.html:52 python_docs_theme/layout.html:112
msgid "Go"
msgstr "Szukaj"

#: python_docs_theme/layout.html:60
msgid "Theme"
msgstr "Motyw"

#: python_docs_theme/layout.html:62
msgid "Auto"
msgstr "auto"

#: python_docs_theme/layout.html:63
msgid "Light"
msgstr "jasny"

#: python_docs_theme/layout.html:64
msgid "Dark"
msgstr "ciemny"

#: python_docs_theme/layout.html:96
msgid "Menu"
msgstr "Menu"

#: python_docs_theme/layout.html:142
msgid "Copyright"
msgstr "Prawa autorskie"

#: python_docs_theme/layout.html:147
msgid ""
"This page is licensed under the Python Software Foundation License "
"Version 2."
msgstr ""
"Ta strona jest objęta licencją Python Software "
"Foundation w wersji 2."

#: python_docs_theme/layout.html:149
msgid ""
"Examples, recipes, and other code in the documentation are additionally "
"licensed under the Zero Clause BSD License."
msgstr ""
"Przykłady, przepisy i inny kod w dokumentacji są dodatkowo objęte "
"licencją Zero Clause BSD."

#: python_docs_theme/layout.html:152
#, python-format
msgid ""
"See <a href=\"%(license_file)s\">History and License</a> for more "
"information."
msgstr ""
"Zobacz <a href=\"%(license_file)s\">Historię i licencję</a> aby uzyskać "
"więcej informacji."

#: python_docs_theme/layout.html:155
#, python-format
msgid "Hosted on %(hosted_on)s."
msgstr "Hostowane na %(hosted_on)s."

#: python_docs_theme/layout.html:163
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Ostatnia aktualizacja %(last_updated)s."

#: python_docs_theme/layout.html:166
#, python-format
msgid "<a href=\"%(theme_issues_url)s\">Found a bug</a>?"
msgstr "<a href=\"%(theme_issues_url)s\">Znalazłeś(-aś) błąd</a>?"

#: python_docs_theme/layout.html:170
#, python-format
msgid ""
"Created using <a href=\"https://www.sphinx-doc.org/\">Sphinx</a> "
"%(sphinx_version)s."
msgstr ""
"Stworzone za pomocą <a href=\"https://www.sphinx-doc.org/\">Sphinx</a> "
"%(sphinx_version)s."

#: python_docs_theme/static/copybutton.js:30
#: python_docs_theme/static/copybutton.js:55
msgid "Copy"
msgstr "Kopiuj"

#: python_docs_theme/static/copybutton.js:31
msgid "Copy to clipboard"
msgstr "Skopiuj do schowka"

#: python_docs_theme/static/copybutton.js:53
msgid "Copied!"
msgstr "Skopiowano!"
Loading