Skip to content

[3.11] GH-84435: Make pyspecific directives translatable (GH-19470) #107682

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
hugovk merged 1 commit into from
Aug 8, 2023
Merged

[3.11] GH-84435: Make pyspecific directives translatable (GH-19470) #107682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 8 additions & 10 deletions Doc/tools/extensions/pyspecific.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,13 @@ class ImplementationDetail(Directive):
final_argument_whitespace = True

# This text is copied to templates/dummy.html
label_text = 'CPython implementation detail:'
label_text = sphinx_gettext('CPython implementation detail:')

def run(self):
self.assert_has_content()
pnode = nodes.compound(classes=['impl-detail'])
label = sphinx_gettext(self.label_text)
content = self.content
add_text = nodes.strong(label, label)
add_text = nodes.strong(self.label_text, self.label_text)
self.state.nested_parse(content, self.content_offset, pnode)
content = nodes.inline(pnode[0].rawsource, translatable=True)
content.source = pnode[0].source
Expand Down Expand Up @@ -239,9 +238,9 @@ class AuditEvent(Directive):
final_argument_whitespace = True

_label = [
"Raises an :ref:`auditing event <auditing>` {name} with no arguments.",
"Raises an :ref:`auditing event <auditing>` {name} with argument {args}.",
"Raises an :ref:`auditing event <auditing>` {name} with arguments {args}.",
sphinx_gettext("Raises an :ref:`auditing event <auditing>` {name} with no arguments."),
sphinx_gettext("Raises an :ref:`auditing event <auditing>` {name} with argument {args}."),
sphinx_gettext("Raises an :ref:`auditing event <auditing>` {name} with arguments {args}."),
]

@property
Expand All @@ -257,7 +256,7 @@ def run(self):
else:
args = []

label = sphinx_gettext(self._label[min(2, len(args))])
label = self._label[min(2, len(args))]
text = label.format(name="``{}``".format(name),
args=", ".join("``{}``".format(a) for a in args if a))

Expand Down Expand Up @@ -419,8 +418,8 @@ class DeprecatedRemoved(Directive):
final_argument_whitespace = True
option_spec = {}

_deprecated_label = 'Deprecated since version {deprecated}, will be removed in version {removed}'
_removed_label = 'Deprecated since version {deprecated}, removed in version {removed}'
_deprecated_label = sphinx_gettext('Deprecated since version {deprecated}, will be removed in version {removed}')
_removed_label = sphinx_gettext('Deprecated since version {deprecated}, removed in version {removed}')

def run(self):
node = addnodes.versionmodified()
Expand All @@ -436,7 +435,6 @@ def run(self):
else:
label = self._removed_label

label = sphinx_gettext(label)
text = label.format(deprecated=self.arguments[0], removed=self.arguments[1])
if len(self.arguments) == 3:
inodes, messages = self.state.inline_text(self.arguments[2],
Expand Down