From ddf4698ab8f950f12ef095ba33949211599d6c57 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 4 Jul 2024 20:10:12 -0700 Subject: [PATCH] allow translating English phrases in json domain output resolves #274 by leveraging `sphinx.locale._` as a translation proxy. Users will have to create .po files with the following phrases translated: - "Required members" - "Optional members" --- sphinx_immaterial/apidoc/json/domain.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sphinx_immaterial/apidoc/json/domain.py b/sphinx_immaterial/apidoc/json/domain.py index c0d0789db..d9758a37c 100644 --- a/sphinx_immaterial/apidoc/json/domain.py +++ b/sphinx_immaterial/apidoc/json/domain.py @@ -40,6 +40,7 @@ import sphinx.util.docutils import sphinx.util.logging import sphinx.util.matching +from sphinx.locale import _ import yaml # pylint: disable=import-error from .. import object_description_options @@ -864,7 +865,7 @@ def _render_related_type_list(related: Optional[List[str]], label: str) -> None: ): continue heading = "%s members" % ("Required" if required else "Optional") - field_list, body = self._make_field(heading) + field_list, body = self._make_field(_(heading)) result.append(field_list) for member_name, member_schema in properties.items(): if (member_name in required_properties) != required: