summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-12-10 19:28:10 (GMT)
committerGitHub <noreply@github.com>2023-12-10 19:28:10 (GMT)
commit2f2668391c69b26e1f25a36e9b6011f3bb43f0d7 (patch)
tree269249bb6792539807d6fdad1e3fe48117a00a10
parent95f5c8c46c16b53c664d9d86eca2682e31167825 (diff)
downloadcpython-2f2668391c69b26e1f25a36e9b6011f3bb43f0d7.zip
cpython-2f2668391c69b26e1f25a36e9b6011f3bb43f0d7.tar.gz
cpython-2f2668391c69b26e1f25a36e9b6011f3bb43f0d7.tar.bz2
[3.11] GH-101986: Support translation for Limited/Unstable API & Stable ABI (GH-107680) (#112941)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
-rw-r--r--Doc/tools/extensions/c_annotations.py14
-rw-r--r--Doc/tools/templates/dummy.html7
2 files changed, 14 insertions, 7 deletions
diff --git a/Doc/tools/extensions/c_annotations.py b/Doc/tools/extensions/c_annotations.py
index 7cb6bd8..2620222 100644
--- a/Doc/tools/extensions/c_annotations.py
+++ b/Doc/tools/extensions/c_annotations.py
@@ -126,7 +126,7 @@ class Annotations:
f"Object type mismatch in limited API annotation "
f"for {name}: {record['role']!r} != {objtype!r}")
stable_added = record['added']
- message = ' Part of the '
+ message = sphinx_gettext(' Part of the ')
emph_node = nodes.emphasis(message, message,
classes=['stableabi'])
ref_node = addnodes.pending_xref(
@@ -134,25 +134,25 @@ class Annotations:
reftype='ref', refexplicit="False")
struct_abi_kind = record['struct_abi_kind']
if struct_abi_kind in {'opaque', 'members'}:
- ref_node += nodes.Text('Limited API')
+ ref_node += nodes.Text(sphinx_gettext('Limited API'))
else:
- ref_node += nodes.Text('Stable ABI')
+ ref_node += nodes.Text(sphinx_gettext('Stable ABI'))
emph_node += ref_node
if struct_abi_kind == 'opaque':
- emph_node += nodes.Text(' (as an opaque struct)')
+ emph_node += nodes.Text(sphinx_gettext(' (as an opaque struct)'))
elif struct_abi_kind == 'full-abi':
- emph_node += nodes.Text(' (including all members)')
+ emph_node += nodes.Text(sphinx_gettext(' (including all members)'))
if record['ifdef_note']:
emph_node += nodes.Text(' ' + record['ifdef_note'])
if stable_added == '3.2':
# Stable ABI was introduced in 3.2.
pass
else:
- emph_node += nodes.Text(f' since version {stable_added}')
+ emph_node += nodes.Text(sphinx_gettext(' since version %s') % stable_added)
emph_node += nodes.Text('.')
if struct_abi_kind == 'members':
emph_node += nodes.Text(
- ' (Only some members are part of the stable ABI.)')
+ sphinx_gettext(' (Only some members are part of the stable ABI.)'))
node.insert(0, emph_node)
# Return value annotation
diff --git a/Doc/tools/templates/dummy.html b/Doc/tools/templates/dummy.html
index bab4aae..4cbc75c 100644
--- a/Doc/tools/templates/dummy.html
+++ b/Doc/tools/templates/dummy.html
@@ -9,6 +9,13 @@ In extensions/pyspecific.py:
In extensions/c_annotations.py:
+{% trans %} Part of the {% endtrans %}
+{% trans %}Limited API{% endtrans %}
+{% trans %}Stable ABI{% endtrans %}
+{% trans %} (as an opaque struct){% endtrans %}
+{% trans %} (including all members){% endtrans %}
+{% trans %} since version %s{% endtrans %}
+{% trans %} (Only some members are part of the stable ABI.){% endtrans %}
{% trans %}Return value: Always NULL.{% endtrans %}
{% trans %}Return value: New reference.{% endtrans %}
{% trans %}Return value: Borrowed reference.{% endtrans %}