Skip to content
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

Jump to bottom

feat(i18n): Infrastructure & Simplified Chinese & Japanese #77

Merged
merged 6 commits into from
Jul 13, 2023
Merged

feat(i18n): Infrastructure & Simplified Chinese & Japanese #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6d102bf
feat(i18n): infra + simplified chinese
BlueGlassBlock Jun 14, 2023
ec80c39
feat(i18n): ja + fix zh_CN fmt
BlueGlassBlock Jun 15, 2023
8b32e89
fix: add polyfill for locale in templates
BlueGlassBlock Jun 16, 2023
6c028af
fix: provide default locale when testing
BlueGlassBlock Jun 19, 2023
1dd2bb0
fix: handle case when locale file does not exists
BlueGlassBlock Jun 20, 2023
981cf47
fixup! feat(i18n): infra + simplified chinese
pawamoy Jul 13, 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
15 changes: 14 additions & 1 deletion src/mkdocstrings_handlers/python/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ def __init__(
*args: Any,
config_file_path: str | None = None,
paths: list[str] | None = None,
locale: str = "en",
**kwargs: Any,
) -> None:
"""Initialize the handler.
Expand All @@ -188,6 +189,7 @@ def __init__(
*args: Handler name, theme and custom templates.
config_file_path: The MkDocs configuration file path.
paths: A list of paths to use as Griffe search paths.
locale: The locale to use when rendering content.
**kwargs: Same thing, but with keyword arguments.
"""
super().__init__(*args, **kwargs)
Expand All @@ -208,6 +210,7 @@ def __init__(
self._paths = search_paths
self._modules_collection: ModulesCollection = ModulesCollection()
self._lines_collection: LinesCollection = LinesCollection()
self._locale = locale

@classmethod
def load_inventory(
Expand Down Expand Up @@ -321,7 +324,13 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa
final_config["signature_crossrefs"] = False

return template.render(
**{"config": final_config, data.kind.value: data, "heading_level": heading_level, "root": True},
**{
"config": final_config,
data.kind.value: data,
"heading_level": heading_level,
"root": True,
"locale": self._locale,
},
)

def update_env(self, md: Markdown, config: dict) -> None: # noqa: D102 (ignore missing docstring)
Expand All @@ -337,6 +346,7 @@ def update_env(self, md: Markdown, config: dict) -> None: # noqa: D102 (ignore
self.env.filters["filter_objects"] = rendering.do_filter_objects
self.env.filters["stash_crossref"] = lambda ref, length: ref
self.env.filters["get_template"] = rendering.do_get_template
self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()

def get_anchors(self, data: CollectorItem) -> set[str]: # noqa: D102 (ignore missing docstring)
try:
Expand All @@ -350,6 +360,7 @@ def get_handler(
custom_templates: str | None = None,
config_file_path: str | None = None,
paths: list[str] | None = None,
locale: str = "en",
**config: Any, # noqa: ARG001
) -> PythonHandler:
"""Simply return an instance of `PythonHandler`.
Expand All @@ -359,6 +370,7 @@ def get_handler(
custom_templates: Directory containing custom templates.
config_file_path: The MkDocs configuration file path.
paths: A list of paths to use as Griffe search paths.
locale: The locale to use when rendering content.
**config: Configuration passed to the handler.

Returns:
Expand All @@ -370,4 +382,5 @@ def get_handler(
custom_templates=custom_templates,
config_file_path=config_file_path,
paths=paths,
locale=locale,
)
17 changes: 10 additions & 7 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
{{ log.debug("Rendering attributes section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
<p><strong>{{ section.title or "Attributes:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Attributes:") }}</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>{{ lang.t("Name") }}</th>
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -33,7 +36,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Attributes:" }}</p>
<p>{{ section.title or lang.t("Attributes:") }}</p>
<ul>
{% for attribute in section.value %}
<li class="field-body">
Expand All @@ -56,8 +59,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "ATTRIBUTE").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("ATTRIBUTE")).rstrip(":").upper() }}</b></th>
<th><b>{{ lang.t("DESCRIPTION") }}</b></th>
</tr>
</thead>
<tbody>
Expand Down
5 changes: 4 additions & 1 deletion src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{{ log.debug("Rendering examples section") }}
<p><strong>{{ section.title or "Examples:" }}</strong></p>

{% import "language.html" as lang with context %}

<p><strong>{{ section.title or lang.t("Examples:") }}</strong></p>
{% for section_type, sub_section in section.value %}
{% if section_type.value == "text" %}
{{ sub_section|convert_markdown(heading_level, html_id) }}
Expand Down
19 changes: 11 additions & 8 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
{{ log.debug("Rendering other parameters section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
<p><strong>{{ section.title or "Other Parameters:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Other Parameters:") }}</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>{{ lang.t("Name") }}</th>
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -33,7 +36,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Other Parameters:" }}</p>
<p>{{ section.title or lang.t("Other Parameters:") }}</p>
<ul>
{% for parameter in section.value %}
<li class="field-body">
Expand All @@ -56,8 +59,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</b></th>
<th><b>{{ lang.t("DESCRIPTION") }}</b></th>
</tr>
</thead>
<tbody>
Expand All @@ -71,7 +74,7 @@
<p>
{% if parameter.annotation %}
<span class="doc-param-annotation">
<b>TYPE:</b>
<b>{{ lang.t("TYPE:") }}</b>
{% with expression = parameter.annotation %}
<code>{% include "expression.html" with context %}</code>
{% endwith %}
Expand Down
25 changes: 14 additions & 11 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
{{ log.debug("Rendering parameters section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
<p><strong>{{ section.title or "Parameters:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Parameters:") }}</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
<th>{{ lang.t("Name") }}</th>
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
<th>{{ lang.t("Default") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -33,7 +36,7 @@
<code>{% include "expression.html" with context %}</code>
{% endwith %}
{% else %}
<em>required</em>
<em>{{ lang.t("required") }}</em>
{% endif %}
</td>
</tr>
Expand All @@ -43,7 +46,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Parameters:" }}</p>
<p>{{ section.title or lang.t("Parameters:") }}</p>
<ul>
{% for parameter in section.value %}
<li class="field-body">
Expand All @@ -66,8 +69,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</b></th>
<th><b> {{ lang.t("DESCRIPTION") }}</b></th>
</tr>
</thead>
<tbody>
Expand All @@ -81,15 +84,15 @@
<p>
{% if parameter.annotation %}
<span class="doc-param-annotation">
<b>TYPE:</b>
<b>{{ lang.t("TYPE:") }}</b>
{% with expression = parameter.annotation %}
<code>{% include "expression.html" with context %}</code>
{% endwith %}
</span>
{% endif %}
{% if parameter.default %}
<span class="doc-param-default">
<b>DEFAULT:</b>
<b>{{ lang.t("DEFAULT:") }}</b>
{% with expression = parameter.default %}
<code>{% include "expression.html" with context %}</code>
{% endwith %}
Expand Down
15 changes: 9 additions & 6 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{{ log.debug("Rendering raises section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
<p><strong>{{ section.title or "Raises:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Raises:") }}</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -31,7 +34,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Raises:" }}</p>
<p>{{ lang.t(section.title) or lang.t("Raises:") }}</p>
<ul>
{% for raises in section.value %}
<li class="field-body">
Expand All @@ -53,8 +56,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "RAISES").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("RAISES")).rstrip(":").upper() }}</b></th>
<th><b>{{ lang.t("DESCRIPTION") }}</b></th>
</tr>
</thead>
<tbody>
Expand Down
19 changes: 11 additions & 8 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
{{ log.debug("Rendering receives section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
{% set name_column = section.value|selectattr("name")|any %}
<p><strong>{{ section.title or "Receives:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Receives:") }}</strong></p>
<table>
<thead>
<tr>
{% if name_column %}<th>Name</th>{% endif %}
<th>Type</th>
<th>Description</th>
{% if name_column %}<th>{{ lang.t("Name") }}</th>{% endif %}
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -34,7 +37,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Receives:" }}</p>
<p>{{ section.title or lang.t("Receives:") }}</p>
<ul>
{% for receives in section.value %}
<li class="field-body">
Expand All @@ -59,8 +62,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "RECEIVES").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("RECEIVES")).rstrip(":").upper()) }}</b></th>
<th><b>{{ lang.t("DESCRIPTION") }}</b></th>
</tr>
</thead>
<tbody>
Expand All @@ -84,7 +87,7 @@
{% if receives.name and receives.annotation %}
<p>
<span class="doc-receives-annotation">
<b>TYPE:</b>
<b>{{ lang.t("TYPE:") }}</b>
{% with expression = receives.annotation %}
<code>{% include "expression.html" with context %}</code>
{% endwith %}
Expand Down
19 changes: 11 additions & 8 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
{{ log.debug("Rendering returns section") }}

{% import "language.html" as lang with context %}

{% if config.docstring_section_style == "table" %}
{% block table_style %}
{% set name_column = section.value|selectattr("name")|any %}
<p><strong>{{ section.title or "Returns:" }}</strong></p>
<p><strong>{{ section.title or lang.t("Returns:") }}</strong></p>
<table>
<thead>
<tr>
{% if name_column %}<th>Name</th>{% endif %}
<th>Type</th>
<th>Description</th>
{% if name_column %}<th>{{ lang.t("Name") }}</th>{% endif %}
<th>{{ lang.t("Type") }}</th>
<th>{{ lang.t("Description") }}</th>
</tr>
</thead>
<tbody>
Expand All @@ -34,7 +37,7 @@
{% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
{% block list_style %}
<p>{{ section.title or "Returns:" }}</p>
<p>{{ section.title or lang.t("Returns:") }}</p>
<ul>
{% for returns in section.value %}
<li class="field-body">
Expand All @@ -59,8 +62,8 @@
<table>
<thead>
<tr>
<th><b>{{ (section.title or "RETURNS").rstrip(":").upper() }}</b></th>
<th><b>DESCRIPTION</b></th>
<th><b>{{ (section.title or lang.t("RETURNS")).rstrip(":").upper() }}</b></th>
<th><b>{{ lang.t("DESCRIPTION").upper() }}</b></th>
</tr>
</thead>
<tbody>
Expand All @@ -84,7 +87,7 @@
{% if returns.name and returns.annotation %}
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
<b>{{ lang.t("TYPE:") }}</b>
{% with expression = returns.annotation %}
<code>{% include "expression.html" with context %}</code>
{% endwith %}
Expand Down
Loading