mkdocstrings-python 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

mkdocstrings_handlers/python/handler.py

@@ -297,7 +297,8 @@ class PythonHandler(BaseHandler):
         mutabled_config = dict(copy.deepcopy(config))
         final_config = ChainMap(mutabled_config, self.default_config)
 
-        template = self.env.get_template(f"{data.kind.value}.html")
+        template_name = rendering.do_get_template(data)
+        template = self.env.get_template(template_name)
 
         # Heading level is a "state" variable, that will change at each step
         # of the rendering recursion. Therefore, it's easier to use it as a plain value
@@ -335,6 +336,7 @@ class PythonHandler(BaseHandler):
         self.env.filters["format_signature"] = rendering.do_format_signature
         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
 
     def get_anchors(self, data: CollectorItem) -> set[str]:  # noqa: D102 (ignore missing docstring)
         try:

mkdocstrings_handlers/python/rendering.py

@@ -248,3 +248,16 @@ def _get_black_formatter() -> Callable[[str, int], str]:
         return format_str(code, mode=mode)
 
     return formatter
+
+
+def do_get_template(obj: Object) -> str:
+    """Get the template name used to render an object.
+
+    Parameters:
+        obj: A Griffe object.
+
+    Returns:
+        A template name.
+    """
+    extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
+    return extra_data.get("template", "") or f"{obj.kind.value}.html"

mkdocstrings_handlers/python/templates/material/_base/children.html

@@ -27,7 +27,7 @@
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
                 {% if not attribute.is_alias or attribute.is_explicitely_exported %}
-                  {% include "attribute.html" with context %}
+                  {% include attribute|get_template with context %}
                 {% endif %}
               {% endfor %}
             {% endwith %}
@@ -42,7 +42,7 @@
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
                 {% if not class.is_alias or class.is_explicitely_exported %}
-                  {% include "class.html" with context %}
+                  {% include class|get_template with context %}
                 {% endif %}
               {% endfor %}
             {% endwith %}
@@ -58,7 +58,7 @@
               {% for function in functions|order_members(config.members_order, members_list) %}
                 {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
                   {% if not function.is_alias or function.is_explicitely_exported %}
-                    {% include "function.html" with context %}
+                    {% include function|get_template with context %}
                   {% endif %}
                 {% endif %}
               {% endfor %}
@@ -75,7 +75,7 @@
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members(config.members_order, members_list) %}
                   {% if not module.is_alias or module.is_explicitely_exported %}
-                    {% include "module.html" with context %}
+                    {% include module|get_template with context %}
                   {% endif %}
                 {% endfor %}
               {% endwith %}
@@ -91,26 +91,26 @@
           filter_objects(filters=config.filters, members_list=members_list, keep_no_docstrings=config.show_if_no_docstring)|
           order_members(config.members_order, members_list) %}
 
-        {% if not (obj.kind.value == "class" and child.name == "__init__" and config.merge_init_into_class) %}
+        {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
 
-          {% if child.kind.value == "attribute" %}
+          {% if child.is_attribute %}
             {% with attribute = child %}
-              {% include "attribute.html" with context %}
+              {% include attribute|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "class" %}
+          {% elif child.is_class %}
             {% with class = child %}
-              {% include "class.html" with context %}
+              {% include class|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "function" %}
+          {% elif child.is_function %}
             {% with function = child %}
-              {% include "function.html" with context %}
+              {% include function|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "module" and config.show_submodules %}
+          {% elif child.is_module and config.show_submodules %}
             {% with module = child %}
-              {% include "module.html" with context %}
+              {% include module|get_template with context %}
             {% endwith %}
 
           {% endif %}

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.0.0
+Version: 1.1.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
 License: ISC
@@ -25,8 +25,8 @@ Project-URL: Changelog, https://mkdocstrings.github.io/python/changelog
 Project-URL: Repository, https://github.com/mkdocstrings/python
 Project-URL: Issues, https://github.com/mkdocstrings/python/issues
 Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
-Project-URL: Gitter, https://gitter.im/python/community
-Project-URL: Funding, https://github.com/sponsors/mkdocstrings
+Project-URL: Gitter, https://gitter.im/mkdocstrings/python
+Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.7
 Requires-Dist: mkdocstrings>=0.20
 Requires-Dist: griffe>=0.24

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 mkdocstrings_handlers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/__init__.py,sha256=CJT3hmg9HpEMy5dbq2jL3Y8unO6UOHND7yCLojwQrS8,326
-mkdocstrings_handlers/python/handler.py,sha256=vX6vRqZRV-nwCFCrjxBUuH0zC1gXwWBHBhgeGHM72Cw,17985
-mkdocstrings_handlers/python/rendering.py,sha256=NMlXtGyE5pQZrdhkwqDnxRLTvc0Kes_T7xGy0-tZiTM,7542
+mkdocstrings_handlers/python/handler.py,sha256=VKDSxsSCFMNsTJSox4VBHLFkqaHk4A7fzUQVli2OxK0,18098
+mkdocstrings_handlers/python/rendering.py,sha256=hjj64VBYJrQlVFF3jxwkla7nG5al6rXl0YH4AsHwPiY,7871
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=JXn5axcd2ssBb02kzs9OVnKvo-UINOIC1ivsGpflIdc,2532
-mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=-FKVAh62bJyqZ3T1R1lgtaRmIsZPnnuAfv-Lov1Hz50,5053
+mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=NOf0LuqOXOg3SVEwwP8ARndWjZrk8q2o-1Ajrrp4dG0,5036
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=wtTLXZl8gvOicdfxOCQaFt_59bn754C1k2ILbE4XvlE,4078
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=LZu_zGw1YyGHN1fq-loPN9eKyYwC3rDWMyQbh31hD20,1740
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=wiD2FtMnGrFMZJDilURnNqzIu8bOR0zcMErUVUqbDPo,274
@@ -53,7 +53,7 @@ mkdocstrings_handlers/python/templates/readthedocs/parameters.html,sha256=c0pfsj
 mkdocstrings_handlers/python/templates/readthedocs/returns.html,sha256=1rvLz7n3xHkhc82mOCJdjgRpGGIFdJqhmiVpv9pdxBE,494
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=FNcAj6sgr1H8cg9MCkqlOMoYeM2EWExIRVRCmilL9YY,600
 mkdocstrings_handlers/python/templates/readthedocs/yields.html,sha256=QLl6geeYfOHJ3xwmuRl-rAScei0DtIxFmlSgVO53Hhc,490
-mkdocstrings_python-1.0.0.dist-info/METADATA,sha256=9nEqCr_Ghp0KTGQx6X_HQjnq5nTTpWwf0FgL8Wufv70,5749
-mkdocstrings_python-1.0.0.dist-info/WHEEL,sha256=7dGFtUmOf30dPBLpGD2z643cxg89joO7p3JHBAwDv6E,90
-mkdocstrings_python-1.0.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.0.0.dist-info/RECORD,,
+mkdocstrings_python-1.1.0.dist-info/METADATA,sha256=aLxaWwtWx69109-NNM1s2QMyr7TnhWnC0fuZjWUub4c,5747
+mkdocstrings_python-1.1.0.dist-info/WHEEL,sha256=m6kf1fJuo48rT4uxh0SeA_FsGq51BpCh_8VNBKVwYQA,90
+mkdocstrings_python-1.1.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.1.0.dist-info/RECORD,,

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.0.6)
+Generator: pdm-backend (2.0.7)
 Root-Is-Purelib: true
 Tag: py3-none-any