mkdocstrings-python 1.16.11__tar.gz → 1.17.0__tar.gz

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/CHANGELOG.md

@@ -5,6 +5,29 @@ 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 -->
+## [1.17.0](https://github.com/mkdocstrings/python/releases/tag/1.17.0) - 2025-08-14
+
+<small>[Compare with 1.16.12](https://github.com/mkdocstrings/python/compare/1.16.12...1.17.0)</small>
+
+### Features
+
+- Support new Griffe parsing options `warn_missing_types` and `warnings` ([0e3bdb8](https://github.com/mkdocstrings/python/commit/0e3bdb857b5ede3e15aa7a9b8b87b33f68889c9e) by Timothée Mazzucotelli). [Issue-mkdocstrings-437](https://github.com/mkdocstrings/mkdocstrings/issues/437)
+- Add `skip_local_inventory` option to prevent objects from being registered in the local objects inventory ([e82c24f](https://github.com/mkdocstrings/python/commit/e82c24f17513fba4cff22e90f0a82c00a01a077d) by Bartosz Sławecki). [Issue-296](https://github.com/mkdocstrings/python/issues/296), [Issue-mkdocstrings-671](https://github.com/mkdocstrings/mkdocstrings/issues/671), [PR-297](https://github.com/mkdocstrings/python/pull/297)
+- Support hiding attribute values ([6cf34b9](https://github.com/mkdocstrings/python/commit/6cf34b9882e20d9147a6481e672ae09989a27796) by Bartosz Sławecki). Issue-292: #292, PR-293: #293
+- Support hiding implementation signature (showing overload only) ([d3b35e1](https://github.com/mkdocstrings/python/commit/d3b35e17384901e7280b8b6926f10fb033480358) by Bartosz Sławecki). [Issue-213](https://github.com/mkdocstrings/python/issues/213), [PR-286](https://github.com/mkdocstrings/python/pull/286)
+
+### Code Refactoring
+
+- Deprecate `locale` option in favor of mkdocstrings' ([17f71ba](https://github.com/mkdocstrings/python/commit/17f71babf11081869478b21b2bde1a33fc97be41) by Timothée Mazzucotelli). [PR-288](https://github.com/mkdocstrings/python/pull/288)
+
+## [1.16.12](https://github.com/mkdocstrings/python/releases/tag/1.16.12) - 2025-06-03
+
+<small>[Compare with 1.16.11](https://github.com/mkdocstrings/python/compare/1.16.11...1.16.12)</small>
+
+### Bug Fixes
+
+- Only replace CSS class in first *highlighting* span ([d57740f](https://github.com/mkdocstrings/python/commit/d57740f874f056fb3ba1c6013ad04227df0f0af8) by Timothée Mazzucotelli). [Issue-281](https://github.com/mkdocstrings/python/issues/281)
+
 ## [1.16.11](https://github.com/mkdocstrings/python/releases/tag/1.16.11) - 2025-05-24
 
 <small>[Compare with 1.16.10](https://github.com/mkdocstrings/python/compare/1.16.10...1.16.11)</small>

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 1.16.11
+Version: 1.17.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC
@@ -30,9 +30,9 @@ 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.9
-Requires-Dist: mkdocstrings>=0.28.3
+Requires-Dist: mkdocstrings>=0.30
 Requires-Dist: mkdocs-autorefs>=1.4
-Requires-Dist: griffe>=1.6.2
+Requires-Dist: griffe>=1.12.1
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/docs/usage/configuration/general.md

@@ -494,3 +494,63 @@ def some_function():
 <p>Docstring of the function.</p>
 ////
 ///
+
+[](){#option-skip_local_inventory}
+## `skip_local_inventory`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
+
+Whether to skip registering symbols in the objects inventory.
+
+With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local. Similarly, it becomes possible to render the same symbol several times in the same documentation, with only one canonical location being used for cross-references (preventing confusion in mkdocs-autorefs).
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          skip_local_inventory: false
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.module
+    options:
+      skip_local_inventory: true
+```
+
+/// admonition | Preview
+    type: preview
+
+
+//// tab | Without `skip_local_inventory`
+
+```md exec="on"
+::: bisect.bisect_left
+    options:
+      heading_level: 3
+      skip_local_inventory: false
+      show_docstring_description: false
+```
+
+Notice how [`bisect.bisect_left`][] now points to the section above.
+
+////
+
+//// tab | With `skip_local_inventory`
+
+```md exec="on"
+::: bisect.bisect_right
+    inventories:
+    - https://docs.python.org/3/objects.inv
+    options:
+      heading_level: 3
+      skip_local_inventory: true
+      show_docstring_description: false
+```
+
+Notice how [`bisect.bisect_right`][] points to the original Python documentation.
+
+////
+///

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/docs/usage/configuration/headings.md

@@ -88,7 +88,7 @@ With this option enabled, each function/method parameter
 (including parameters of `__init__` methods merged in their parent class
 with the [`merge_init_into_class`][] option)
 gets a permalink, an entry in the Table of Contents,
-and an entry in the generated objects inventory.
+and an entry in the generated objects inventory (unless [`skip_local_inventory`][] is enabled).
 The permalink and inventory entry allow cross-references
 from internal and external pages.
 

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/docs/usage/configuration/signatures.md

@@ -286,6 +286,56 @@ plugins:
 
 ///
 
+[](){#option-overloads_only}
+## `overloads_only`
+
+Whether to hide the implementation signature if the overloads are shown with [`show_overloads`][].
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          overloads_only: true
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.module
+    options:
+      overloads_only: true
+```
+
+/// admonition | Preview
+    type: preview
+//// tab | With overloads only
+<h2>function</h2>
+
+```python
+@overload
+function(param1: int): ...
+@overload
+function(param1: str): ...
+```
+Function docstring.
+
+////
+//// tab | Without overloads only
+<h2>function</h2>
+
+```python
+@overload
+function(param1: int): ...
+@overload
+function(param1: str): ...
+function(param1: str | int)
+```
+Function docstring.
+
+////
+
+///
+
 [](){#option-show_signature}
 ## `show_signature`
 
@@ -433,6 +483,49 @@ function(param1, param2=None)
 ////
 ///
 
+[](){#option-show_attribute_values}
+## `show_attribute_values`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
+
+Show initial values of attributes in classes.
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_attribute_values: true
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.object
+    options:
+      show_attribute_values: true
+```
+
+```python title="package/module.py"
+class SomeClass:
+  def __init__(self):
+      self.some_attr = 1
+```
+
+/// admonition | Preview
+    type: preview
+
+//// tab | With attribute values visible
+<h2><code>SomeClass</code></h2>
+<p>some_attr = 1</p>
+////
+
+//// tab | With attribute values hidden
+<h2><code>SomeClass</code></h2>
+<p>some_attr</p>
+////
+///
+
 [](){#option-show_overloads}
 ## `show_overloads`
 

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/docs/usage/index.md

@@ -150,9 +150,11 @@ plugins:
   [__all__]: https://docs.python.org/3/tutorial/modules.html#importing-from-a-package
 
 [](){#setting-locale}
-#### `locale`
+#### ~~`locale`~~
 
-The locale to use when translating template strings. The translation system is not fully ready yet, so we don't recommend setting the option for now.
+**Deprecated.** Use mkdocstrings' own `locale` setting.
+
+~~The locale to use when translating template strings.~~
 
 [](){#setting-paths}
 #### `paths`

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/duties.py

@@ -240,7 +240,7 @@ def coverage(ctx: Context) -> None:
 
 
 @duty
-def test(ctx: Context, *cli_args: str, match: str = "", snapshot: str = "report") -> None:
+def test(ctx: Context, *cli_args: str, match: str = "", snapshot: str = "report") -> None:  # noqa: PT028
     """Run the test suite.
 
     Parameters:

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/pyproject.toml

@@ -37,12 +37,12 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.28.3",
+    "mkdocstrings>=0.30",
     "mkdocs-autorefs>=1.4",
-    "griffe>=1.6.2",
+    "griffe>=1.12.1",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.16.11"
+version = "1.17.0"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -112,7 +112,7 @@ ci = [
     "pytest-randomly>=3.15",
     "pytest-xdist>=3.6",
     "beautifulsoup4>=4.12.3",
-    "inline-snapshot>=0.18",
+    "inline-snapshot>=0.25",
     "mypy>=1.10",
     "types-markdown>=3.6",
     "types-pyyaml>=6.0",

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -186,6 +186,24 @@ class GoogleStyleOptions:
         ),
     ] = True
 
+    warn_missing_types: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Warn about missing type/annotation for parameters, return values, etc.",
+        ),
+    ] = True
+
+    warnings: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Generally enable/disable warnings when parsing docstrings.",
+        ),
+    ] = True
+
 
 # YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
 @dataclass(**_dataclass_options)  # type: ignore[call-overload]
@@ -219,12 +237,57 @@ class NumpyStyleOptions:
         ),
     ] = True
 
+    warn_missing_types: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Warn about missing type/annotation for parameters, return values, etc.",
+        ),
+    ] = True
+
+    warnings: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Generally enable/disable warnings when parsing docstrings.",
+        ),
+    ] = True
+
 
 # YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
 @dataclass(**_dataclass_options)  # type: ignore[call-overload]
 class SphinxStyleOptions:
     """Sphinx style docstring options."""
 
+    warn_unknown_params: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Warn about documented parameters not appearing in the signature.",
+        ),
+    ] = True
+
+    warn_missing_types: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Warn about missing type/annotation for return values.",
+        ),
+    ] = True
+
+    warnings: Annotated[
+        bool,
+        _Field(
+            group="docstrings",
+            parent="docstring_options",
+            description="Generally enable/disable warnings when parsing docstrings.",
+        ),
+    ] = True
+
 
 # YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
 @dataclass(**_dataclass_options)  # type: ignore[call-overload]
@@ -554,6 +617,14 @@ class PythonInputOptions:
         ),
     ] = False
 
+    overloads_only: Annotated[
+        bool,
+        _Field(
+            group="signatures",
+            description="Whether to hide the implementation signature if the overloads are shown.",
+        ),
+    ] = False
+
     parameter_headings: Annotated[
         bool,
         _Field(
@@ -614,6 +685,14 @@ class PythonInputOptions:
         ),
     ] = False
 
+    show_attribute_values: Annotated[
+        bool,
+        _Field(
+            group="signatures",
+            description="Show initial values of attributes in classes.",
+        ),
+    ] = True
+
     show_bases: Annotated[
         bool,
         _Field(
@@ -849,6 +928,14 @@ class PythonInputOptions:
         ),
     ] = False
 
+    skip_local_inventory: Annotated[
+        bool,
+        _Field(
+            group="general",
+            description="Whether to prevent objects from being registered in the local objects inventory.",
+        ),
+    ] = False
+
     signature_crossrefs: Annotated[
         bool,
         _Field(
@@ -1019,7 +1106,9 @@ class PythonInputConfig:
 
     locale: Annotated[
         str | None,
-        _Field(description="The locale to use when translating template strings."),
+        _Field(
+            description="Deprecated. Use mkdocstrings' own `locale` setting instead. The locale to use when translating template strings.",
+        ),
     ] = None
 
     @classmethod

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -278,12 +278,13 @@ class PythonHandler(BaseHandler):
 
         return doc_object
 
-    def render(self, data: CollectorItem, options: PythonOptions) -> str:
+    def render(self, data: CollectorItem, options: PythonOptions, locale: str | None = None) -> str:
         """Render the collected data.
 
         Parameters:
             data: The collected data.
             options: The options to use for rendering.
+            locale: The locale to use for rendering (default is "en").
 
         Returns:
             The rendered data (HTML).
@@ -300,7 +301,8 @@ class PythonHandler(BaseHandler):
                 # than as an item in a dictionary.
                 "heading_level": options.heading_level,
                 "root": True,
-                "locale": self.config.locale,
+                # YORE: Bump 2: Regex-replace ` or .+` with ` or "en",` within line.
+                "locale": locale or self.config.locale,
             },
         )
 
@@ -360,7 +362,7 @@ class PythonHandler(BaseHandler):
             return tuple(f"{alias}({parameter})" for alias in aliases)
         return tuple(aliases)
 
-    def normalize_extension_paths(self, extensions: Sequence) -> Sequence:
+    def normalize_extension_paths(self, extensions: Sequence) -> list[str | dict[str, Any]]:
         """Resolve extension paths relative to config file.
 
         Parameters:
@@ -369,7 +371,7 @@ class PythonHandler(BaseHandler):
         Returns:
             The normalized extensions.
         """
-        normalized = []
+        normalized: list[str | dict[str, Any]] = []
 
         for ext in extensions:
             if isinstance(ext, dict):
@@ -401,6 +403,7 @@ def get_handler(
     Parameters:
         handler_config: The handler configuration.
         tool_config: The tool (SSG) configuration.
+        **kwargs: Additional arguments to pass to the handler.
 
     Returns:
         An instance of `PythonHandler`.

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -190,7 +190,7 @@ def do_format_signature(
     # To fix this, we replace the CSS class in the first span with `nf`,
     # unless we already found an `nf` span.
     if not re.search(r'<span class="nf">', signature):
-        signature = re.sub(r'<span class="[a-z]+">', '<span class="nf">', signature, count=1)
+        signature = re.sub(r'<span class="[a-z]{1,2}">', '<span class="nf">', signature, count=1)
 
     if stash := env.filters["stash_crossref"].stash:
         for key, value in stash.items():
@@ -208,6 +208,7 @@ def do_format_attribute(
     line_length: int,
     *,
     crossrefs: bool = False,  # noqa: ARG001
+    show_value: bool = True,
 ) -> str:
     """Format an attribute.
 
@@ -235,7 +236,7 @@ def do_format_attribute(
             backlink_type="returned-by",
         )
         signature += f": {annotation}"
-    if attribute.value:
+    if show_value and attribute.value:
         value = template.render(context.parent, expression=attribute.value, signature=True, backlink_type="used-by")
         signature += f" = {value}"
 
@@ -261,7 +262,7 @@ def do_format_attribute(
 def do_order_members(
     members: Sequence[Object | Alias],
     order: Order | list[Order],
-    members_list: bool | list[str] | None,
+    members_list: bool | list[str] | None,  # noqa: FBT001
 ) -> Sequence[Object | Alias]:
     """Order members given an ordering method.
 
@@ -522,7 +523,7 @@ def _get_formatter() -> Callable[[str, int], str]:
 
 def _get_ruff_formatter() -> Callable[[str, int], str] | None:
     try:
-        from ruff.__main__ import find_ruff_bin
+        from ruff.__main__ import find_ruff_bin  # noqa: PLC0415
     except ImportError:
         return None
 
@@ -558,7 +559,7 @@ def _get_ruff_formatter() -> Callable[[str, int], str] | None:
 
 def _get_black_formatter() -> Callable[[str, int], str] | None:
     try:
-        from black import InvalidInput, Mode, format_str
+        from black import InvalidInput, Mode, format_str  # noqa: PLC0415
     except ModuleNotFoundError:
         return None
 
@@ -638,7 +639,7 @@ def do_as_attributes_section(
                 name=attribute.name,
                 description=_parse_docstring_summary(attribute),
                 annotation=attribute.annotation,
-                value=attribute.value,  # type: ignore[arg-type]
+                value=attribute.value,
             )
             for attribute in attributes
             if not check_public or attribute.is_public

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -40,6 +40,7 @@ Context:
           id=html_id,
           class="doc doc-heading",
           toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute.name),
+          skip_inventory=config.skip_local_inventory,
         ) %}
 
         {% block heading scoped %}
@@ -55,7 +56,7 @@ Context:
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
               {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}
-              {% if attribute.value %} = {{ attribute.value }}{% endif %}
+              {% if config.show_attribute_values and attribute.value %} = {{ attribute.value }}{% endif %}
             {% endfilter %}
           {% endif %}
         {% endblock heading %}
@@ -79,7 +80,7 @@ Context:
         This block renders the signature for the attribute.
         -#}
         {% if config.separate_signature %}
-          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs) %}
+          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs, show_value=config.show_attribute_values) %}
             {{ attribute.name }}
           {% endfilter %}
         {% endif %}
@@ -93,6 +94,7 @@ Context:
             id=html_id,
             toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute_name),
             hidden=True,
+            skip_inventory=config.skip_local_inventory,
           ) %}
         {% endfilter %}
       {% endif %}

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

@@ -45,7 +45,7 @@ Context:
           ) %}
           {% if attributes %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-attributes") %}Attributes{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-attributes", skip_inventory=config.skip_local_inventory) %}Attributes{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
@@ -65,7 +65,7 @@ Context:
           ) %}
           {% if classes %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-classes") %}Classes{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-classes", skip_inventory=config.skip_local_inventory) %}Classes{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
@@ -85,7 +85,7 @@ Context:
           ) %}
           {% if functions %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}Functions{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}
@@ -108,7 +108,7 @@ Context:
             ) %}
             {% if modules %}
               {% if config.show_category_heading %}
-                {% filter heading(heading_level, id=html_id ~ "-modules") %}Modules{% endfilter %}
+                {% filter heading(heading_level, id=html_id ~ "-modules", skip_inventory=config.skip_local_inventory) %}Modules{% endfilter %}
               {% endif %}
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members("alphabetical", members_list) %}

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

@@ -39,6 +39,7 @@ Context:
           id=html_id,
           class="doc doc-heading",
           toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
+          skip_inventory=config.skip_local_inventory,
         ) %}
 
         {% block heading scoped %}
@@ -112,6 +113,7 @@ Context:
             id=html_id,
             toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
             hidden=True,
+            skip_inventory=config.skip_local_inventory,
           ) %}
         {% endfilter %}
       {% endif %}

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja

@@ -43,6 +43,7 @@ Context:
                     id=html_id ~ "(" ~ parameter.name ~ ")",
                     class="doc doc-heading doc-heading-parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
+                    skip_inventory=config.skip_local_inventory,
                   ) %}
                   <code>{{ parameter.name }}</code>
                 {% endfilter %}
@@ -92,6 +93,7 @@ Context:
                 id=html_id ~ "(" ~ parameter.name ~ ")",
                 class="doc doc-heading doc-heading-parameter",
                 toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
+                skip_inventory=config.skip_local_inventory,
               ) %}
               <b><code>{{ parameter.name }}</code></b>
             {% endfilter %}
@@ -139,6 +141,7 @@ Context:
                     id=html_id ~ "(" ~ parameter.name ~ ")",
                     class="doc doc-heading doc-heading-parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
+                    skip_inventory=config.skip_local_inventory,
                   ) %}
                   <code>{{ parameter.name }}</code>
                 {% endfilter %}

{mkdocstrings_python-1.16.11 → mkdocstrings_python-1.17.0}/src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

@@ -46,6 +46,7 @@ Context:
           id=html_id,
           class="doc doc-heading",
           toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
+          skip_inventory=config.skip_local_inventory,
         ) %}
 
         {% block heading scoped %}
@@ -94,7 +95,7 @@ Context:
             {% endfor %}
           </div>
         {% endif %}
-        {% if config.separate_signature %}
+        {% if config.separate_signature and not (config.show_overloads and function.overloads and config.overloads_only) %}
           {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
             {{ function.name }}
           {% endfilter %}
@@ -110,6 +111,7 @@ Context:
             id=html_id,
             toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
             hidden=True,
+            skip_inventory=config.skip_local_inventory,
           ) %}
         {% endfilter %}
       {% endif %}