mkdocstrings-python 1.8.0__tar.gz → 1.9.1__tar.gz

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.8.0
+Version: 1.9.1
 Summary: A Python handler for mkdocstrings.
-Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
+Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
 License: ISC
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -16,7 +16,6 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Project-URL: Homepage, https://mkdocstrings.github.io/python
@@ -28,6 +27,7 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
 Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.8
+Requires-Dist: markdown<3.6,>=3.3
 Requires-Dist: mkdocstrings>=0.20
 Requires-Dist: griffe>=0.37
 Description-Content-Type: text/markdown
@@ -36,23 +36,11 @@ Description-Content-Type: text/markdown
 
 <p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
 
-<p align="center">
-  <a href="https://github.com/mkdocstrings/python/actions?query=workflow%3Aci">
-    <img alt="ci" src="https://github.com/mkdocstrings/python/workflows/ci/badge.svg" />
-  </a>
-  <a href="https://mkdocstrings.github.io/python/">
-    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
-  </a>
-  <a href="https://pypi.org/project/mkdocstrings-python/">
-    <img alt="pypi version" src="https://img.shields.io/pypi/v/mkdocstrings-python.svg" />
-  </a>
-  <a href="https://gitpod.io/#https://github.com/mkdocstrings/python">
-    <img alt="gitpod" src="https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat" />
-  </a>
-  <a href="https://app.gitter.im/#/room/#mkdocstrings_python:gitter.im">
-    <img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" />
-  </a>
-</p>
+[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/python/)
+[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/python)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)
 
 ---
 

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/README.md

@@ -2,23 +2,11 @@
 
 <p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
 
-<p align="center">
-  <a href="https://github.com/mkdocstrings/python/actions?query=workflow%3Aci">
-    <img alt="ci" src="https://github.com/mkdocstrings/python/workflows/ci/badge.svg" />
-  </a>
-  <a href="https://mkdocstrings.github.io/python/">
-    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
-  </a>
-  <a href="https://pypi.org/project/mkdocstrings-python/">
-    <img alt="pypi version" src="https://img.shields.io/pypi/v/mkdocstrings-python.svg" />
-  </a>
-  <a href="https://gitpod.io/#https://github.com/mkdocstrings/python">
-    <img alt="gitpod" src="https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat" />
-  </a>
-  <a href="https://app.gitter.im/#/room/#mkdocstrings_python:gitter.im">
-    <img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" />
-  </a>
-</p>
+[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/python/)
+[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/python)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)
 
 ---
 

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "pdm.backend"
 name = "mkdocstrings-python"
 description = "A Python handler for mkdocstrings."
 authors = [
-    { name = "Timothée Mazzucotelli", email = "pawamoy@pm.me" },
+    { name = "Timothée Mazzucotelli", email = "dev@pawamoy.fr" },
 ]
 readme = "README.md"
 requires-python = ">=3.8"
@@ -27,15 +27,15 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Topic :: Documentation",
     "Topic :: Software Development",
-    "Topic :: Software Development :: Documentation",
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
 dependencies = [
+    "markdown>=3.3,<3.6",
     "mkdocstrings>=0.20",
     "griffe>=0.37",
 ]
-version = "1.8.0"
+version = "1.9.1"
 
 [project.license]
 text = "ISC"
@@ -50,11 +50,6 @@ Discussions = "https://github.com/mkdocstrings/python/discussions"
 Gitter = "https://gitter.im/mkdocstrings/python"
 Funding = "https://github.com/sponsors/pawamoy"
 
-[tool.pdm]
-plugins = [
-    "pdm-multirun",
-]
-
 [tool.pdm.version]
 source = "scm"
 
@@ -64,49 +59,3 @@ includes = [
     "src/mkdocstrings_handlers",
 ]
 editable-backend = "editables"
-
-[tool.pdm.dev-dependencies]
-duty = [
-    "duty>=0.10",
-]
-ci-quality = [
-    "mkdocstrings-python[duty,docs,quality,typing,security]",
-]
-ci-tests = [
-    "mkdocstrings-python[duty,docs,tests]",
-]
-docs = [
-    "black>=23.9",
-    "markdown-callouts>=0.3",
-    "markdown-exec>=1.7",
-    "mkdocs>=1.5",
-    "mkdocs-coverage>=1.0",
-    "mkdocs-gen-files>=0.5",
-    "mkdocs-git-committers-plugin-2>=1.2",
-    "mkdocs-literate-nav>=0.6",
-    "mkdocs-material>=9.4",
-    "mkdocs-minify-plugin>=0.7",
-    "tomli>=2.0; python_version < '3.11'",
-]
-maintain = [
-    "black>=23.9",
-    "blacken-docs>=1.16",
-    "git-changelog>=2.3",
-]
-quality = [
-    "ruff>=0.0",
-]
-tests = [
-    "pytest>=7.4",
-    "pytest-cov>=4.1",
-    "pytest-randomly>=3.15",
-    "pytest-xdist>=3.3",
-]
-typing = [
-    "mypy>=1.5",
-    "types-markdown>=3.5",
-    "types-pyyaml>=6.0",
-]
-security = [
-    "safety>=2.3",
-]

mkdocstrings_python-1.9.1/src/mkdocstrings_handlers/python/__init__.py

@@ -0,0 +1,5 @@
+"""Python handler for mkdocstrings."""
+
+from mkdocstrings_handlers.python.handler import get_handler
+
+__all__ = ["get_handler"]

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/handler.py

@@ -61,6 +61,7 @@ class PythonHandler(BaseHandler):
     fallback_config: ClassVar[dict] = {"fallback": True}
     """The configuration used to collect item during autorefs fallback."""
     default_config: ClassVar[dict] = {
+        "find_stubs_package": False,
         "docstring_style": "google",
         "docstring_options": {},
         "show_symbol_type_heading": False,
@@ -105,11 +106,13 @@ class PythonHandler(BaseHandler):
         "preload_modules": None,
         "allow_inspection": True,
         "summary": False,
+        "show_labels": True,
         "unwrap_annotated": False,
     }
     """Default handler configuration.
 
     Attributes: General options:
+        find_stubs_package (bool): Whether to load stubs package (package-stubs) when extracting docstrings. Default `False`.
         allow_inspection (bool): Whether to allow inspecting modules when visiting them is not possible. Default: `True`.
         show_bases (bool): Show the base classes of a class. Default: `True`.
         show_source (bool): Show the source code of this object. Default: `True`.
@@ -152,6 +155,7 @@ class PythonHandler(BaseHandler):
         group_by_category (bool): Group the object's children by categories: attributes, classes, functions, and modules. Default: `True`.
         show_submodules (bool): When rendering a module, show its submodules recursively. Default: `False`.
         summary (bool | dict[str, bool]): Whether to render summaries of modules, classes, functions (methods) and attributes.
+        show_labels (bool): Whether to show labels of the members. Default: `True`.
 
     Attributes: Docstrings options:
         docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`.
@@ -279,8 +283,16 @@ class PythonHandler(BaseHandler):
             try:
                 for pre_loaded_module in final_config.get("preload_modules") or []:
                     if pre_loaded_module not in self._modules_collection:
-                        loader.load(pre_loaded_module)
-                loader.load(module_name)
+                        loader.load(
+                            pre_loaded_module,
+                            try_relative_path=False,
+                            find_stubs_package=final_config["find_stubs_package"],
+                        )
+                loader.load(
+                    module_name,
+                    try_relative_path=False,
+                    find_stubs_package=final_config["find_stubs_package"],
+                )
             except ImportError as error:
                 raise CollectionError(str(error)) from error
             unresolved, iterations = loader.resolve_aliases(

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/rendering.py

@@ -166,6 +166,15 @@ def do_format_signature(
         ),
     )
 
+    # Since we highlight the signature without `def`,
+    # Pygments sees it as a function call and not a function definition.
+    # The result is that the function name is not parsed as such,
+    # but instead as a regular name: `n` CSS class instead of `nf`.
+    # To fix it, we replace the first occurrence of an `n` CSS class
+    # with an `nf` one, unless we found `nf` already.
+    if signature.find('class="nf"') == -1:
+        signature = signature.replace('class="n"', 'class="nf"', 1)
+
     if stash:
         for key, value in stash.items():
             signature = re.sub(rf"\b{key}\b", value, signature)

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Attributes:") }}</strong></p>
   <table>
     <thead>
@@ -35,7 +35,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Attributes:") }}</p>
   <ul>
     {% for attribute in section.value %}
@@ -55,7 +55,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Classes:") }}</strong></p>
   <table>
     <thead>
@@ -27,7 +27,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Classes:") }}</p>
   <ul>
     {% for class in section.value %}
@@ -42,7 +42,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</strong></p>
   <table>
     <thead>
@@ -29,7 +29,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</p>
   <ul>
     {% for function in section.value %}
@@ -46,7 +46,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Modules:") }}</strong></p>
   <table>
     <thead>
@@ -27,7 +27,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Modules:") }}</p>
   <ul>
     {% for module in section.value %}
@@ -42,7 +42,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Other Parameters:") }}</strong></p>
   <table>
     <thead>
@@ -35,7 +35,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Other Parameters:") }}</p>
   <ul>
     {% for parameter in section.value %}
@@ -55,7 +55,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Parameters:") }}</strong></p>
   <table>
     <thead>
@@ -45,7 +45,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Parameters:") }}</p>
   <ul>
     {% for parameter in section.value %}
@@ -70,7 +70,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Raises:") }}</strong></p>
   <table>
     <thead>
@@ -33,7 +33,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ lang.t(section.title) or lang.t("Raises:") }}</p>
   <ul>
     {% for raises in section.value %}
@@ -52,7 +52,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or lang.t("Receives:") }}</strong></p>
   <table>
@@ -36,7 +36,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Receives:") }}</p>
   <ul>
     {% for receives in section.value %}
@@ -58,7 +58,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or lang.t("Returns:") }}</strong></p>
   <table>
@@ -36,7 +36,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Returns:") }}</p>
   <ul>
     {% for returns in section.value %}
@@ -58,7 +58,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   <p><strong>{{ section.title or lang.t("Warns:") }}</strong></p>
   <table>
     <thead>
@@ -33,7 +33,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Warns:") }}</p>
   <ul>
     {% for warns in section.value %}
@@ -52,7 +52,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html

@@ -3,7 +3,7 @@
 {% import "language.html" as lang with context %}
 
 {% if config.docstring_section_style == "table" %}
-  {% block table_style %}
+  {% block table_style scoped %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or lang.t("Yields:") }}</strong></p>
   <table>
@@ -36,7 +36,7 @@
   </table>
   {% endblock table_style %}
 {% elif config.docstring_section_style == "list" %}
-  {% block list_style %}
+  {% block list_style scoped %}
   <p>{{ section.title or lang.t("Yields:") }}</p>
   <ul>
     {% for yields in section.value %}
@@ -58,7 +58,7 @@
   </ul>
   {% endblock list_style %}
 {% elif config.docstring_section_style == "spacy" %}
-  {% block spacy_style %}
+  {% block spacy_style scoped %}
   <table>
     <thead>
       <tr>

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html

@@ -1,4 +1,4 @@
-{% if labels %}
+{% if config.show_labels and labels %}
   {{ log.debug("Rendering labels") }}
   <span class="doc doc-labels">
     {% for label in labels|sort %}

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/src/mkdocstrings_handlers/python/templates/material/style.css

@@ -105,4 +105,9 @@ code.doc-symbol-module {
 
 code.doc-symbol-module::after {
   content: "mod";
-}
+}
+
+.doc-signature .autorefs {
+  color: inherit;
+  border-bottom: 1px dotted currentcolor;
+}

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/tests/conftest.py

@@ -60,7 +60,7 @@ def fixture_plugin(mkdocs_conf: config.Config) -> MkdocstringsPlugin:
     """Return a plugin instance.
 
     Parameters:
-        mkdocs_conf: Pytest fixture: [tests.conftest.fixture_mkdocs_conf][].
+        mkdocs_conf: Pytest fixture (see conftest.py).
 
     Returns:
         mkdocstrings plugin instance.
@@ -73,7 +73,7 @@ def fixture_ext_markdown(mkdocs_conf: config.Config) -> Markdown:
     """Return a Markdown instance with MkdocstringsExtension.
 
     Parameters:
-        mkdocs_conf: Pytest fixture: [tests.conftest.fixture_mkdocs_conf][].
+        mkdocs_conf: Pytest fixture (see conftest.py).
 
     Returns:
         A Markdown instance.
@@ -86,7 +86,7 @@ def fixture_handler(plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> Pytho
     """Return a handler instance.
 
     Parameters:
-        plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
+        plugin: Pytest fixture (see conftest.py).
 
     Returns:
         A handler instance.

{mkdocstrings_python-1.8.0 → mkdocstrings_python-1.9.1}/tests/test_themes.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import sys
 from typing import TYPE_CHECKING
 
 import pytest
@@ -22,7 +21,7 @@ if TYPE_CHECKING:
     indirect=["plugin"],
 )
 @pytest.mark.parametrize(
-    "module",
+    "identifier",
     [
         "mkdocstrings.extension",
         "mkdocstrings.inventory",
@@ -33,15 +32,15 @@ if TYPE_CHECKING:
         "mkdocstrings_handlers.python",
     ],
 )
-@pytest.mark.skipif(sys.version_info < (3, 7), reason="material is not installed on Python 3.6")
-def test_render_themes_templates_python(module: str, plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> None:
+def test_render_themes_templates_python(identifier: str, plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> None:
     """Test rendering of a given theme's templates.
 
     Parameters:
-        module: Parametrized argument.
-        plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
+        identifier: Parametrized identifier.
+        plugin: Pytest fixture (see conftest.py).
+        ext_markdown: Pytest fixture (see conftest.py).
     """
     handler = plugin.handlers.get_handler("python")
     handler._update_env(ext_markdown, plugin.handlers._config)
-    data = handler.collect(module, {})
+    data = handler.collect(identifier, {})
     handler.render(data, {})

mkdocstrings_python-1.8.0/src/mkdocstrings_handlers/python/__init__.py

@@ -1,9 +0,0 @@
-"""This package implements a handler for the Python language."""
-
-from mkdocstrings_handlers.python.handler import get_handler
-
-__all__ = ["get_handler"]
-
-# TODO: CSS classes everywhere in templates
-# TODO: name normalization (filenames, Jinja2 variables, HTML tags, CSS classes)
-# TODO: Jinja2 blocks everywhere in templates