Skip to content

GH-101986: Support translation for Limited/Unstable API & Stable ABI #107680

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

Merged
merged 3 commits into from
Dec 10, 2023
Merged

GH-101986: Support translation for Limited/Unstable API & Stable ABI #107680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20ab801
Support translation for Limited/Unstable API & Stable ABI
AA-Turner Aug 6, 2023
839ac93
Update Doc/tools/extensions/c_annotations.py
AA-Turner Aug 16, 2023
860587a
Merge branch 'main' into c-annotations-translate
hugovk Dec 10, 2023
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
20 changes: 10 additions & 10 deletions Doc/tools/extensions/c_annotations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,48 +126,48 @@ def add_annotations(self, app, doctree):
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(
'Stable ABI', refdomain="std", reftarget='stable',
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)

# Unstable API annotation.
if name.startswith('PyUnstable'):
warn_node = nodes.admonition(
classes=['unstable-c-api', 'warning'])
message = 'This is '
message = sphinx_gettext('This is ')
emph_node = nodes.emphasis(message, message)
ref_node = addnodes.pending_xref(
'Unstable API', refdomain="std",
reftarget='unstable-c-api',
reftype='ref', refexplicit="False")
ref_node += nodes.Text('Unstable API')
ref_node += nodes.Text(sphinx_gettext('Unstable API'))
emph_node += ref_node
emph_node += nodes.Text('. It may change without warning in minor releases.')
emph_node += nodes.Text(sphinx_gettext('. It may change without warning in minor releases.'))
warn_node += emph_node
node.insert(0, warn_node)

Expand Down
10 changes: 10 additions & 0 deletions Doc/tools/templates/dummy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@

In extensions/c_annotations.py:

{% trans %} Part of the {% endtrans %}
Copy link
Contributor

@egeakman egeakman Jan 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@AA-Turner sphinx-lint complains about the trailing whitespaces here and here, and if I remove these whitespace in the translation (po file), the HTML ends up like this: (no spaces in-between)

image

image

image

and so on

Could we remove these trailing whitespaces here, and insert them at the beginning of Limited API and Stable ABI?

We can remove all the whitespaces (leading and trailing) in the template file and modify c_annotations.py to handle the spacing.

{% 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 %}This is {% endtrans %}
{% trans %}Unstable API{% endtrans %}
{% trans %}. It may change without warning in minor releases.{% endtrans %}
{% trans %}Return value: Always NULL.{% endtrans %}
{% trans %}Return value: New reference.{% endtrans %}
{% trans %}Return value: Borrowed reference.{% endtrans %}
Expand Down