1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
"""
Script for conveniently updating the translation files.
Run this script with:
.. code::
python3 intl.py
You can also pass the language code as an argument:
.. code::
python3 intl.py de
Do not pass the default language code as an argument.
"""
import json
import sys
import subprocess
from pathlib import Path
from typing import List
root = Path(__file__).parent
"""
Make sure to run this script from the root of the documenation repository.
"""
all_languages: List[str]
"""
List of currently supported languages, taken from ``doc/src/_static/languages.json``.
To support a new language add its `language code`_ to the list.
.. _language code: https://www.sphinx-doc.org/en/master/usage/configuration.html#intl-options
"""
with open(root / "src" / "_static" / "languages.json") as fd:
all_languages = list(json.load(fd).values())
def intl_gettext() -> None:
"""
Update the ``gettext`` translation files.
"""
subprocess.run(
["sphinx-build", "-b", "gettext", str(root / "src"), str(root / "_gettext")],
cwd=root,
)
def intl_update(language: str) -> None:
"""
Update a translation file.
Parameters
----------
language : str
Language to update.
"""
subprocess.run(
[
"sphinx-intl",
"update",
"-l",
language,
"-d",
str(root / "locale"),
"-p",
str(root / "_gettext"),
],
cwd=root,
)
def intl_all(languages: List[str]) -> None:
"""
Update all translation files.
Parameters
----------
languages : List[str]
List of languages to update.
"""
intl_gettext()
intl_update(",".join(languages))
if __name__ == "__main__":
languages = sys.argv[1:] if len(sys.argv) > 1 else all_languages[1:]
intl_all(languages)
print()
print("Please commit the changes to the translation files if necessary.")
print()
print(f" git add \"{root / 'locale'}\"")
print()
|
