mkdocstrings-python 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

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_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_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_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_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_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_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": "产生",

{mkdocstrings_python-2.0.0.dist-info → mkdocstrings_python-2.0.1.dist-info}/METADATA

@@ -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.dist-info → mkdocstrings_python-2.0.1.dist-info}/RECORD

@@ -2,16 +2,16 @@ mkdocstrings_handlers/python/__init__.py,sha256=Kxy1zA4JJy0aWxUa2_xl5PfYV2-mrBKJ
 mkdocstrings_handlers/python/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/_internal/config.py,sha256=DzPjS4rqrCw_C6xQ5ThpFI6iM3nF7hPsAG370bPVICg,35271
 mkdocstrings_handlers/python/_internal/debug.py,sha256=A6B3w6LWN22kYtvvbmz7vnh8Pr5hzvtrHhM3-Es8Isg,2882
-mkdocstrings_handlers/python/_internal/handler.py,sha256=WMFgIJxW9Ww3zPyKsQ7dcbvDBfm_fO-5J_SITmjQX68,15635
+mkdocstrings_handlers/python/_internal/handler.py,sha256=ukqik2XjIbeUj3T1pyVhcVk-gU_DtbK8tSwhiaYgxqQ,15655
 mkdocstrings_handlers/python/_internal/rendering.py,sha256=9h8mF2r41dx9Gaef-3W7zpIuU7m_3lUtbGCitL23uSY,28642
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=ajtKaGxs9-VJzPNiXbQTYTO6ADq8Ck9M9x2BfXakG0g,4838
 mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja,sha256=k8eX0lyQmmooaEotjYngdXO8RJldjixvZW30S5jGXOA,2109
-mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=zPORhI3jnTmZRDDQ7LymGmgpDD31v7j6L9gsrx9U55g,7882
-mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=8e84CW4_vWn5lMtKWp7IZjJEsJObIpShAKK82-W8yvs,12002
+mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=nzWeNjIgVSZgBD3IDaaoxRtxUA1zkSYGQMfDjGahl4g,8112
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=Wo_g0ag5P7d3rolVRYxtJMIT2U1KC9h7rh8yQFcuprQ,12153
 mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=iKi-31JKoHwG7-w3S88A9YTu9kuV6-c9gwKb8bUtXuw,3440
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja,sha256=VFwImgb1toxkjWqyhTNFQbyYE3d11yXI___3vpIu2u0,687
-mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja,sha256=L8SNxn5M1pt1NmDFhJ6ZXM9k_ajv1ENOpjzYKQLLv7g,4179
+mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja,sha256=r5xPFwDwyzkGF8aNi66kRD3BRqcr_msDgZyrOOc6rSQ,4195
 mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja,sha256=WQW2f6iNgMObPF7X44hXIw_5vTfQeKFhdmlsVX6iUVY,3152
 mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja,sha256=CxkEQ5bThOv0jq-zpkz7ZPMuHohd-6DEpor_Ojr7t-4,967
 mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja,sha256=UrdJTx_mcfkp7z3rGVh_5vFHwNTh4oFh_wPpB8pR0qs,3691
@@ -29,9 +29,9 @@ mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha2
 mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=AljcQjr1e6laOEpp4LRPKjnQNkN99zcPISxbXeEqPf4,6239
 mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja,sha256=mue5CMl2WQpagj3aYqbUiAQX0P72aLCgY3MX_zEpE8s,786
 mkdocstrings_handlers/python/templates/material/_base/language.html.jinja,sha256=7gyknTiapqCM8TjUHdXkQgZMmYwcuy6Ze0pkntE7g8s,617
-mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja,sha256=3Uq6sZocqwk6LZTV0ht3tBo2iBDCzABuEcrehZzAhQY,1591
-mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja,sha256=Ee01TL-nz5vK9PJXAqGhqPgyWsB2xc877XUCcVSbkac,1701
-mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=IgoNgHvSpkfBu54fh2Af_nPbmdwEYuuu455P8BFp8NU,1583
+mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja,sha256=tzS9C3l1c5liALvpYl7dHOGhtoFpRQwMgm_gAVKcv_Y,1731
+mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja,sha256=UUxdQrbwgRISh0qL8OkjRi7L6gjbGIg1ot-pg0OdyJk,1874
+mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=uWvh_jTzUb9kpmM72tOdPi5u40_-_4VcHpUau1R9-A8,1705
 mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=1_9zC61tvsPKlaRRSMpZDXhssefWMurqY_KY4AWqr1M,4425
 mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja,sha256=D8GkrfnZv-ap4i2pOs-QGKW585iKTQyfe4kANK42O_8,5115
 mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja,sha256=jZSNC5ECuwm_W_I3P6_R8VHMEe_s8VJKTxixS1zTY3g,841
@@ -114,8 +114,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/en.html.jinja,sha25
 mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha256=e_DPZvMvaaJm0QyjTxW8SkBEbhMXBgBiMrLJ1osAwZc,46
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
-mkdocstrings_python-2.0.0.dist-info/METADATA,sha256=3yPFgpe-lhA8lYUd-EZaOpcuV8jYzgZhELjqIsGGYGY,13889
-mkdocstrings_python-2.0.0.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
-mkdocstrings_python-2.0.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-2.0.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-2.0.0.dist-info/RECORD,,
+mkdocstrings_python-2.0.1.dist-info/METADATA,sha256=kYesKsPbLsxLk6k3YcLCvmG-Bw8HYQZEyssnMpii_g0,13889
+mkdocstrings_python-2.0.1.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
+mkdocstrings_python-2.0.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-2.0.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-2.0.1.dist-info/RECORD,,