mkdocstrings-python 2.0.0__tar.gz → 2.0.1__tar.gz

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/CHANGELOG.md

@@ -5,6 +5,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [2.0.1](https://github.com/mkdocstrings/python/releases/tag/2.0.1) - 2025-12-03
+
+<small>[Compare with 2.0.0](https://github.com/mkdocstrings/python/compare/2.0.0...2.0.1)</small>
+
+### Bug Fixes
+
+- Don't ignore filters when category grouping is disabled ([63aa1b0](https://github.com/mkdocstrings/python/commit/63aa1b0af0d14912ebf83a4e3c2cd0c7f2a19dae) by Timothée Mazzucotelli). [Issue-324](https://github.com/mkdocstrings/python/issues/324)
+
+### Code Refactoring
+
+- Localize more contents in templates ([854b6a6](https://github.com/mkdocstrings/python/commit/854b6a601bd334fe544285aa9eae11482388a583) by Zhikang Yan). [PR-321](https://github.com/mkdocstrings/python/pull/321)
+- Improve ja/zh translations ([b83107c](https://github.com/mkdocstrings/python/commit/b83107c8e86d9650fe4544e569f6da16a46b8472) by Zhikang Yan). [PR-322](https://github.com/mkdocstrings/python/pull/322)
+
 ## [2.0.0](https://github.com/mkdocstrings/python/releases/tag/2.0.0) - 2025-11-27
 
 <small>[Compare with 1.19.0](https://github.com/mkdocstrings/python/compare/1.19.0...2.0.0)</small>

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.0
+Version: 2.0.1
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/duties.py

@@ -5,16 +5,12 @@ from __future__ import annotations
 import os
 import re
 import sys
-from contextlib import contextmanager
-from importlib.metadata import version as pkgversion
 from pathlib import Path
 from typing import TYPE_CHECKING
 
 from duty import duty, tools
 
 if TYPE_CHECKING:
-    from collections.abc import Iterator
-
     from duty.context import Context
 
 
@@ -36,18 +32,6 @@ def pyprefix(title: str) -> str:
     return title
 
 
-@contextmanager
-def material_insiders() -> Iterator[bool]:
-    if "+insiders" in pkgversion("mkdocs-material"):
-        os.environ["MATERIAL_INSIDERS"] = "true"
-        try:
-            yield True
-        finally:
-            os.environ.pop("MATERIAL_INSIDERS")
-    else:
-        yield False
-
-
 def _get_changelog_version() -> str:
     changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
     with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
@@ -88,11 +72,10 @@ def check_docs(ctx: Context) -> None:
     """Check if the documentation builds correctly."""
     Path("htmlcov").mkdir(parents=True, exist_ok=True)
     Path("htmlcov/index.html").touch(exist_ok=True)
-    with material_insiders():
-        ctx.run(
-            tools.mkdocs.build(strict=True, verbose=True),
-            title=pyprefix("Building documentation"),
-        )
+    ctx.run(
+        tools.mkdocs.build(strict=True, verbose=True),
+        title=pyprefix("Building documentation"),
+    )
 
 
 @duty(nofail=PY_VERSION == PY_DEV)
@@ -126,22 +109,18 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
         host: The host to serve the docs from.
         port: The port to serve the docs on.
     """
-    with material_insiders():
-        ctx.run(
-            tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
-            title="Serving documentation",
-            capture=False,
-        )
+    ctx.run(
+        tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
+        title="Serving documentation",
+        capture=False,
+    )
 
 
 @duty(skip_if=sys.version_info < (3, 13), skip_reason=pyprefix("Skipped: docs require modern generics syntax"))
 def docs_deploy(ctx: Context) -> None:
     """Deploy the documentation to GitHub pages."""
     os.environ["DEPLOY"] = "true"
-    with material_insiders() as insiders:
-        if not insiders:
-            ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
-        ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
+    ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
 
 
 @duty

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/mkdocs.yml

@@ -197,11 +197,7 @@ plugins:
       reference/mkdocstrings_handlers/python/debug.md: reference/api.md#mkdocstrings_handlers.python.debug
       reference/mkdocstrings_handlers/python/handler.md: reference/api.md#mkdocstrings_handlers.python.handler
       reference/mkdocstrings_handlers/python/rendering.md: reference/api.md#mkdocstrings_handlers.python.rendering
-
-- group:
-    enabled: !ENV [MATERIAL_INSIDERS, false]
-    plugins:
-    - typeset
+- typeset
 
 extra:
   social:

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "griffe>=1.13",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "2.0.0"
+version = "2.0.1"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -139,7 +139,7 @@ class PythonHandler(BaseHandler):
     ) -> Iterator[tuple[str, str]]:
         """Yield items and their URLs from an inventory file streamed from `in_file`.
 
-        This implements mkdocstrings' `load_inventory` "protocol" (see [`mkdocstrings.plugin`][]).
+        This implements mkdocstrings' `load_inventory` "protocol" (see [`mkdocstrings.BaseHandler.load_inventory`][]).
 
         Arguments:
             in_file: The binary file-like object to read the inventory from.

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/children.html.jinja

@@ -19,6 +19,9 @@ Context:
     {{ log.debug("Rendering children of " + obj.path) }}
   {% endblock logs %}
 
+  {% import "language.html.jinja" as lang with context %}
+  {#- Language module providing the `t` translation method. -#}
+
   <div class="doc doc-children">
 
     {% if root_members %}
@@ -45,7 +48,7 @@ Context:
           ) %}
           {% if attributes %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-attributes", skip_inventory=config.skip_local_inventory) %}Attributes{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-attributes", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Attributes") }}{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
@@ -65,7 +68,7 @@ Context:
           ) %}
           {% if type_aliases %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-type_aliases") %}Type Aliases{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-type_aliases") %}{{ lang.t("Type Aliases") }}{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for type_alias in type_aliases|order_members(config.members_order, members_list) %}
@@ -85,7 +88,7 @@ Context:
           ) %}
           {% if classes %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-classes", skip_inventory=config.skip_local_inventory) %}Classes{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-classes", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Classes") }}{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
@@ -105,7 +108,7 @@ Context:
           ) %}
           {% if functions %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}Functions{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Functions") }}{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}
@@ -128,7 +131,7 @@ Context:
             ) %}
             {% if modules %}
               {% if config.show_category_heading %}
-                {% filter heading(heading_level, id=html_id ~ "-modules", skip_inventory=config.skip_local_inventory) %}Modules{% endfilter %}
+                {% filter heading(heading_level, id=html_id ~ "-modules", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Modules") }}{% endfilter %}
               {% endif %}
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members("alphabetical", members_list) %}
@@ -157,7 +160,7 @@ Context:
 
         {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
 
-          {% if config.filters == "public" or members_list is not none or child.is_public %}
+          {% if config.filters == "public" or members_list is not none or (not child.is_imported or child.is_public) %}
             {% if child.is_attribute %}
               {% with attribute = child %}
                 {% include attribute|get_template with context %}

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja

@@ -17,6 +17,9 @@ Context:
   {{ log.debug("Rendering " + class.path) }}
 {% endblock logs %}
 
+{% import "language.html.jinja" as lang with context %}
+{#- Language module providing the `t` translation method. -#}
+
 <div class="doc doc-object doc-class">
   {% with obj = class, html_id = class.path, all_members = class.all_members %}
 
@@ -246,7 +249,7 @@ Context:
               {% if "__init__" in all_members and all_members["__init__"].source %}
                 {% with init = all_members["__init__"] %}
                   <details class="mkdocstrings-source">
-                    <summary>Source code in <code>
+                    <summary>{{ lang.t("Source code in") }} <code>
                       {%- if init.relative_filepath.is_absolute() -%}
                         {{ init.relative_package_filepath }}
                       {%- else -%}
@@ -259,7 +262,7 @@ Context:
               {% endif %}
             {% elif class.source %}
               <details class="mkdocstrings-source">
-                <summary>Source code in <code>
+                <summary>{{ lang.t("Source code in") }} <code>
                   {%- if class.relative_filepath.is_absolute() -%}
                     {{ class.relative_package_filepath }}
                   {%- else -%}

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja

@@ -93,7 +93,7 @@ Context:
               <p>
                 {% if attribute.annotation %}
                   <span class="doc-attribute-annotation">
-                    <b>TYPE:</b>
+                    <b>{{ lang.t("TYPE:") }}</b>
                     {% with expression = attribute.annotation %}
                       <code>{% include "expression.html.jinja" with context %}</code>
                     {% endwith %}

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja

@@ -9,9 +9,11 @@
 
 {% macro t(key) %}{{ {
   "ATTRIBUTE": "ATTRIBUTE",
+  "Attributes": "Attributes",
   "Attributes:": "Attributes:",
   "BOUND:": "BOUND:",
   "Bound or Constraints": "Bound or Constraints",
+  "Classes": "Classes",
   "Classes:": "Classes:",
   "Class Type Parameters:": "Class Type Parameters:",
   "CLASS TYPE PARAMETER": "CLASS TYPE PARAMETER",
@@ -23,12 +25,14 @@
   "DESCRIPTION": "DESCRIPTION",
   "Description": "Description",
   "Examples:": "Examples:",
+  "Functions": "Functions",
   "Functions:": "Functions:",
   "FUNCTION": "FUNCTION",
   "Init Type Parameters:": "Init Type Parameters:",
   "INIT TYPE PARAMETER": "INIT TYPE PARAMETER",
   "Methods:": "Methods:",
   "METHOD": "METHOD",
+  "Modules": "Modules",
   "Modules:": "Modules:",
   "MODULE": "MODULE",
   "Name": "Name",
@@ -45,6 +49,7 @@
   "Source code in": "Source code in",
   "TYPE:": "TYPE:",
   "Type": "Type",
+  "Type Aliases": "Type Aliases",
   "Type Aliases:": "Type Aliases:",
   "TYPE ALIAS": "TYPE ALIAS",
   "Type Parameters:": "Type Parameters:",

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja

@@ -9,26 +9,30 @@
 
 {% macro t(key) %}{{ {
   "ATTRIBUTE": "属性",
+  "Attributes": "属性",
   "Attributes:": "属性：",
-  "BOUND:": "BOUND:",
-  "Bound or Constraints": "Bound or Constraints",
+  "BOUND:": "境界：",
+  "Bound or Constraints": "境界や制約",
+  "Classes": "クラス",
   "Classes:": "クラス：",
   "Class Type Parameters:": "Class Type Parameters:",
   "CLASS TYPE PARAMETER": "CLASS TYPE PARAMETER",
-  "CLASS": "CLASS",
-  "CONSTRAINTS:": "CONSTRAINTS:",
+  "CLASS": "クラス",
+  "CONSTRAINTS:": "制約：",
   "DEFAULT:": "デフォルト：",
   "Default": "デフォルト",
   "default:": "デフォルト：",
   "DESCRIPTION": "デスクリプション",
   "Description": "デスクリプション",
   "Examples:": "例：",
+  "Functions": "関数",
   "Functions:": "関数：",
   "FUNCTION": "関数",
   "Init Type Parameters:": "Init Type Parameters:",
   "INIT TYPE PARAMETER": "INIT TYPE PARAMETER",
   "Methods:": "メソッド：",
   "METHOD": "メソッド",
+  "Modules": "モジュール",
   "Modules:": "モジュール：",
   "MODULE": "モジュール",
   "Name": "名前",
@@ -45,10 +49,11 @@
   "Source code in": "ソースコード位置：",
   "TYPE:": "タイプ：",
   "Type": "タイプ",
-  "Type Aliases:": "Type Aliases:",
-  "TYPE ALIAS": "TYPE ALIAS",
-  "Type Parameters:": "Type Parameters:",
-  "TYPE PARAMETER": "TYPE PARAMETER",
+  "Type Aliases": "型エイリアス",
+  "Type Aliases:": "型エイリアス：",
+  "TYPE ALIAS": "型エイリアス",
+  "Type Parameters:": "型パラメータ：",
+  "TYPE PARAMETER": "型パラメータ",
   "WARNS": "警告",
   "Warns:": "警告：",
   "YIELDS": "返す",

{mkdocstrings_python-2.0.0 → mkdocstrings_python-2.0.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja

@@ -9,26 +9,30 @@
 
 {% macro t(key) %}{{ {
   "ATTRIBUTE": "属性",
+  "Attributes": "属性",
   "Attributes:": "属性：",
-  "BOUND:": "BOUND:",
-  "Bound or Constraints": "Bound or Constraints",
+  "BOUND:": "边界：",
+  "Bound or Constraints": "边界或约束",
+  "Classes": "类",
   "Classes:": "类：",
   "Class Type Parameters:": "Class Type Parameters:",
   "CLASS TYPE PARAMETER": "CLASS TYPE PARAMETER",
-  "CLASS": "CLASS",
-  "CONSTRAINTS:": "CONSTRAINTS:",
+  "CLASS": "类",
+  "CONSTRAINTS:": "约束：",
   "DEFAULT:": "默认：",
   "Default": "默认",
   "default:": "默认：",
   "DESCRIPTION": "描述",
   "Description": "描述",
   "Examples:": "示例：",
+  "Functions": "函数",
   "Functions:": "函数：",
   "FUNCTION": "函数",
   "Init Type Parameters:": "Init Type Parameters:",
   "INIT TYPE PARAMETER": "INIT TYPE PARAMETER",
   "Methods:": "方法：",
   "METHOD": "方法",
+  "Modules": "模块",
   "Modules:": "模块：",
   "MODULE": "模块",
   "Name": "名称",
@@ -45,10 +49,11 @@
   "Source code in": "源代码位于：",
   "TYPE:": "类型：",
   "Type": "类型",
-  "Type Aliases:": "Type Aliases:",
-  "TYPE ALIAS": "TYPE ALIAS",
-  "Type Parameters:": "Type Parameters:",
-  "TYPE PARAMETER": "TYPE PARAMETER",
+  "Type Aliases": "类型别名",
+  "Type Aliases:": "类型别名：",
+  "TYPE ALIAS": "类型别名",
+  "Type Parameters:": "类型形参：",
+  "TYPE PARAMETER": "类型形参",
   "Warns:": "警告：",
   "WARNS": "警告",
   "YIELDS": "产生",