mkdocstrings-python 1.12.1__tar.gz → 1.13.0__tar.gz

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.13.0](https://github.com/mkdocstrings/python/releases/tag/1.13.0) - 2024-12-26
+
+<small>[Compare with 1.12.2](https://github.com/mkdocstrings/python/compare/1.12.2...1.13.0)</small>
+
+### Features
+
+- Allow using Ruff to format signatures and attribute values ([d67215c](https://github.com/mkdocstrings/python/commit/d67215c976938ef1e169f16dd0b6166067ebd7bc) by dm). [PR-216](https://github.com/mkdocstrings/python/pull/216)
+
+### Bug Fixes
+
+- Respect `show_signature_annotations` option for attribute signatures in headings ([e93d166](https://github.com/mkdocstrings/python/commit/e93d166a14d0944d30ff2f28f21f2262ac396bff) by Timothée Mazzucotelli). [Issue-griffe-pydantic#9](https://github.com/mkdocstrings/griffe-pydantic/issues/9)
+- Handle `__init__` overloads when merging into class ([af6fab3](https://github.com/mkdocstrings/python/commit/af6fab31142204872ace716392dcb314b2cb5d0f) by Timothée Mazzucotelli). [Issue-212](https://github.com/mkdocstrings/python/issues/212)
+- Actually check if a module is public when rendering auto-generated summary table for modules ([3bf55b2](https://github.com/mkdocstrings/python/commit/3bf55b22ce9a841242c55b2efcedbd8f3a99ccc9) by Timothée Mazzucotelli). [Issue-203](https://github.com/mkdocstrings/python/issues/203)
+- Never render line numbers for signatures and attribute values ([a669f1c](https://github.com/mkdocstrings/python/commit/a669f1caefbd54305cc4610bdd57a529aa1208cf) by Timothée Mazzucotelli). [Issue-192](https://github.com/mkdocstrings/python/issues/192)
+- Respect highlight's `linenums` config for `pycon` examples in docstrings ([53eb82a](https://github.com/mkdocstrings/python/commit/53eb82a21bbcaa959306e909bf0d4ac468f87580) by Timothée Mazzucotelli). [Related-to-#192](https://github.com/mkdocstrings/python/issues/192)
+- Fix normalization of extension paths on the annoying operating system and Python 3.13 ([101a6dc](https://github.com/mkdocstrings/python/commit/101a6dc428da59a512da617a0a2453f2b6ef4387) by Timothée Mazzucotelli).
+- Don't merge parent `__init__` docstring into class docstring if such inherited method wasn't selected through the `inherited_members` configuration option ([6c5b5c3](https://github.com/mkdocstrings/python/commit/6c5b5c341940af9425b3de0672ac400794b3f6e5) by Timothée Mazzucotelli). [Issue-189](https://github.com/mkdocstrings/python/issues/189)
+
+### Code Refactoring
+
+- Render `*` and `**` outside of cross-references in signatures ([c4506f0](https://github.com/mkdocstrings/python/commit/c4506f080e0c75cd32d6512c80f5016e82fc12bc) by Timothée Mazzucotelli). [Needed-for-PR-216](https://github.com/mkdocstrings/python/pull/216)
+
+## [1.12.2](https://github.com/mkdocstrings/python/releases/tag/1.12.2) - 2024-10-19
+
+<small>[Compare with 1.12.1](https://github.com/mkdocstrings/python/compare/1.12.1...1.12.2)</small>
+
+### Bug Fixes
+
+- Always render cross-references outside of signatures ([73f11dc](https://github.com/mkdocstrings/python/commit/73f11dcc584a672af7e17738cba08a50f119176a) by Timothée Mazzucotelli). [Issue-mkdocstrings#700](https://github.com/mkdocstrings/mkdocstrings/issues/700)
+
 ## [1.12.1](https://github.com/mkdocstrings/python/releases/tag/1.12.1) - 2024-10-14
 
 <small>[Compare with 1.12.0](https://github.com/mkdocstrings/python/compare/1.12.0...1.12.1)</small>

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.12.1
+Version: 1.13.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC
@@ -41,7 +41,6 @@ Description-Content-Type: text/markdown
 [![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-708FCC.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-708FCC.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.12.1 → mkdocstrings_python-1.13.0}/README.md

@@ -5,7 +5,6 @@
 [![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-708FCC.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-708FCC.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.12.1 → mkdocstrings_python-1.13.0}/docs/.glossary.md

@@ -8,5 +8,6 @@
 [Spacy's documentation]: https://spacy.io/api/doc/
 [Black]: https://pypi.org/project/black/ 
 [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material
+[Ruff]: https://docs.astral.sh/ruff
 
 *[ToC]: Table of Contents

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/docs/insiders/index.md

@@ -92,6 +92,8 @@ else:
 ```
 <!-- blacken-docs:on -->
 
+Additionally, your sponsorship will give more weight to your upvotes on issues, helping us prioritize work items in our backlog. For more information on how we prioritize work, see this page: [Backlog management](https://pawamoy.github.io/backlog/).
+
 ## How to become a sponsor
 
 Thanks for your interest in sponsoring! In order to become an eligible sponsor

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/docs/schema.json

@@ -145,7 +145,7 @@
               "default": false
             },
             "separate_signature": {
-              "title": "Whether to put the whole signature in a code block below the heading. If Black is installed, the signature is also formatted using it.",
+              "title": "Whether to put the whole signature in a code block below the heading. If a formatter (Black or Ruff) is installed, the signature is also formatted using it.",
               "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#separate_signature",
               "type": "boolean",
               "default": false

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/docs/usage/configuration/docstrings.md

@@ -427,6 +427,7 @@ class Class:
 
 ///
 
+INFO: **There is an alternative, third-party Python handler that handles relative references: [mkdocstrings-python-xref](https://github.com/analog-garage/mkdocstrings-python-xref).**
 
 ## `scoped_crossrefs`
 

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/docs/usage/configuration/signatures.md

@@ -154,10 +154,15 @@ def convert(text: str, md: Markdown) -> Markup:
 Maximum line length when formatting code/signatures.
 
 When separating signatures from headings with the [`separate_signature`][] option,
-the Python handler will try to format the signatures using [Black] and
+the Python handler will try to format the signatures using a formatter and
 the specified line length.
 
-If Black is not installed, the handler issues an INFO log once.
+The handler will automatically try to format using :
+
+1. [Black]
+2. [Ruff]
+
+If a formatter is not found, the handler issues an INFO log once.
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:
@@ -380,10 +385,15 @@ function(param1, param2=None)
 Whether to put the whole signature in a code block below the heading.
 
 When separating signatures from headings,
-the Python handler will try to format the signatures using [Black] and
+the Python handler will try to format the signatures using a formatter and
 the specified [line length][line_length].
 
-If Black is not installed, the handler issues an INFO log once.
+The handler will automatically try to format using :
+
+1. [Black]
+2. [Ruff]
+
+If a formatter is not found, the handler issues an INFO log once.
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/duties.py

@@ -217,20 +217,26 @@ def coverage(ctx: Context) -> None:
 
 
 @duty
-def test(ctx: Context, *cli_args: str, match: str = "") -> None:
+def test(ctx: Context, *cli_args: str, match: str = "", snapshot: str = "report") -> None:
     """Run the test suite.
 
     Parameters:
         match: A pytest expression to filter selected tests.
+        snapshot: Whether to "create", "fix", "trim", or "update" snapshots.
     """
     py_version = f"{sys.version_info.major}{sys.version_info.minor}"
     os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
+    args = list(cli_args)
+    if snapshot == "disable" or not snapshot:
+        args = ["-n", "auto", "--inline-snapshot=disable"]
+    else:
+        args = [f"--inline-snapshot={snapshot}"]
     ctx.run(
         tools.pytest(
             "tests",
             config_file="config/pytest.ini",
             select=match,
             color="yes",
-        ).add_args("-n", "auto", *cli_args),
+        ).add_args(*args),
         title=pyprefix("Running tests"),
     )

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/pyproject.toml

@@ -37,7 +37,7 @@ dependencies = [
     "mkdocs-autorefs>=1.2",
     "griffe>=0.49",
 ]
-version = "1.12.1"
+version = "1.13.0"
 
 [project.license]
 text = "ISC"
@@ -53,7 +53,8 @@ Gitter = "https://gitter.im/mkdocstrings/python"
 Funding = "https://github.com/sponsors/pawamoy"
 
 [tool.pdm.version]
-source = "scm"
+source = "call"
+getter = "scripts.get_version:get_version"
 
 [tool.pdm.build]
 package-dir = "src"
@@ -81,9 +82,11 @@ data = [
     { path = "share/**/*", relative-to = "." },
 ]
 
-[tool.uv]
-dev-dependencies = [
-    "editables>=0.5",
+[tool.inline-snapshot]
+storage-dir = "tests/snapshots"
+
+[dependency-groups]
+dev = [
     "build>=1.2",
     "git-changelog>=2.5",
     "twine>=5.1",
@@ -93,6 +96,8 @@ dev-dependencies = [
     "pytest-cov>=5.0",
     "pytest-randomly>=3.15",
     "pytest-xdist>=3.6",
+    "beautifulsoup4>=4.12.3",
+    "inline-snapshot>=0.18",
     "mypy>=1.10",
     "types-markdown>=3.6",
     "types-pyyaml>=6.0",

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/scripts/gen_credits.py

@@ -27,7 +27,7 @@ with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
     pyproject = tomllib.load(pyproject_file)
 project = pyproject["project"]
 project_name = project["name"]
-devdeps = [dep for dep in pyproject["tool"]["uv"]["dev-dependencies"] if not dep.startswith("-e")]
+devdeps = [dep for dep in pyproject["dependency-groups"]["dev"] if not dep.startswith("-e")]
 
 PackageMetadata = dict[str, Union[str, Iterable[str]]]
 Metadata = dict[str, PackageMetadata]

mkdocstrings_python-1.13.0/scripts/get_version.py

@@ -0,0 +1,27 @@
+"""Get current project version from Git tags or changelog."""
+
+import re
+from contextlib import suppress
+from pathlib import Path
+
+from pdm.backend.hooks.version import SCMVersion, Version, default_version_formatter, get_version_from_scm
+
+_root = Path(__file__).parent.parent
+_changelog = _root / "CHANGELOG.md"
+_changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
+_default_scm_version = SCMVersion(Version("0.0.0"), None, False, None, None)  # noqa: FBT003
+
+
+def get_version() -> str:
+    """Get current project version from Git tags or changelog."""
+    scm_version = get_version_from_scm(_root) or _default_scm_version
+    if scm_version.version <= Version("0.1"):  # Missing Git tags?
+        with suppress(OSError, StopIteration):  # noqa: SIM117
+            with _changelog.open("r", encoding="utf8") as file:
+                match = next(filter(None, map(_changelog_version_re.match, file)))
+                scm_version = scm_version._replace(version=Version(match.group(1)))
+    return default_version_formatter(scm_version)
+
+
+if __name__ == "__main__":
+    print(get_version())

mkdocstrings_python-1.13.0/scripts/make

@@ -0,0 +1 @@
+make.py

mkdocstrings_python-1.12.1/scripts/make → mkdocstrings_python-1.13.0/scripts/make.py

@@ -10,12 +10,16 @@ import sys
 from contextlib import contextmanager
 from pathlib import Path
 from textwrap import dedent
-from typing import Any, Iterator
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 
 PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.9 3.10 3.11 3.12 3.13 3.14").split()
 
 
-def shell(cmd: str, capture_output: bool = False, **kwargs: Any) -> str | None:
+def shell(cmd: str, *, capture_output: bool = False, **kwargs: Any) -> str | None:
     """Run a shell command."""
     if capture_output:
         return subprocess.check_output(cmd, shell=True, text=True, **kwargs)  # noqa: S602
@@ -49,15 +53,15 @@ def setup() -> None:
     if not shutil.which("uv"):
         raise ValueError("make: setup: uv must be installed, see https://github.com/astral-sh/uv")
 
-    print("Installing dependencies (default environment)")  # noqa: T201
+    print("Installing dependencies (default environment)")
     default_venv = Path(".venv")
     if not default_venv.exists():
-        shell("uv venv --python python")
+        shell("uv venv")
     uv_install(default_venv)
 
     if PYTHON_VERSIONS:
         for version in PYTHON_VERSIONS:
-            print(f"\nInstalling dependencies (python{version})")  # noqa: T201
+            print(f"\nInstalling dependencies (python{version})")
             venv_path = Path(f".venvs/{version}")
             if not venv_path.exists():
                 shell(f"uv venv --python {version} {venv_path}")
@@ -65,12 +69,10 @@ def setup() -> None:
                 uv_install(venv_path)
 
 
-def run(version: str, cmd: str, *args: str, no_sync: bool = False, **kwargs: Any) -> None:
+def run(version: str, cmd: str, *args: str, **kwargs: Any) -> None:
     """Run a command in a virtual environment."""
     kwargs = {"check": True, **kwargs}
-    uv_run = ["uv", "run"]
-    if no_sync:
-        uv_run.append("--no-sync")
+    uv_run = ["uv", "run", "--no-sync"]
     if version == "default":
         with environ(UV_PROJECT_ENVIRONMENT=".venv"):
             subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
@@ -99,7 +101,7 @@ def clean() -> None:
     """Delete build artifacts and cache files."""
     paths_to_clean = ["build", "dist", "htmlcov", "site", ".coverage*", ".pdm-build"]
     for path in paths_to_clean:
-        shell(f"rm -rf {path}")
+        shutil.rmtree(path, ignore_errors=True)
 
     cache_dirs = {".cache", ".pytest_cache", ".mypy_cache", ".ruff_cache", "__pycache__"}
     for dirpath in Path(".").rglob("*/"):
@@ -109,8 +111,7 @@ def clean() -> None:
 
 def vscode() -> None:
     """Configure VSCode to work on this project."""
-    Path(".vscode").mkdir(parents=True, exist_ok=True)
-    shell("cp -v config/vscode/* .vscode")
+    shutil.copytree("config/vscode", ".vscode", dirs_exist_ok=True)
 
 
 def main() -> int:
@@ -132,13 +133,13 @@ def main() -> int:
                       3.x                   Run a command in the virtual environment for Python 3.x.
                       clean                 Delete build artifacts and cache files.
                       vscode                Configure VSCode to work on this project.
-                    """
+                    """,
                 ),
                 flush=True,
-            )  # noqa: T201
+            )
             if os.path.exists(".venv"):
-                print("\nAvailable tasks", flush=True)  # noqa: T201
-                run("default", "duty", "--list", no_sync=True)
+                print("\nAvailable tasks", flush=True)
+                run("default", "duty", "--list")
         return 0
 
     while args:
@@ -186,5 +187,5 @@ if __name__ == "__main__":
         sys.exit(main())
     except subprocess.CalledProcessError as process:
         if process.output:
-            print(process.output, file=sys.stderr)  # noqa: T201
+            print(process.output, file=sys.stderr)
         sys.exit(process.returncode)

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/src/mkdocstrings_handlers/python/handler.py

@@ -201,7 +201,7 @@ class PythonHandler(BaseHandler):
         show_signature_annotations (bool): Show the type annotations in methods and functions signatures. Default: `False`.
         signature_crossrefs (bool): Whether to render cross-references for type annotations in signatures. Default: `False`.
         separate_signature (bool): Whether to put the whole signature in a code block below the heading.
-            If Black is installed, the signature is also formatted using it. Default: `False`.
+            If a formatter (Black or Ruff) is installed, the signature is also formatted using it. Default: `False`.
         unwrap_annotated (bool): Whether to unwrap `Annotated` types to show only the type without the annotations. Default: `False`.
         modernize_annotations (bool): Whether to modernize annotations, for example `Optional[str]` into `str | None`. Default: `False`.
     """
@@ -469,11 +469,9 @@ class PythonHandler(BaseHandler):
                 pth = str(ext)
                 options = None
 
-            if pth.endswith(".py") or ".py:" in pth or "/" in pth or "\\" in pth:  # noqa: SIM102
-                # This is a sytem path. Normalize it.
-                if not os.path.isabs(pth):
-                    # Make path absolute relative to config file path.
-                    pth = os.path.normpath(os.path.join(base_path, pth))
+            if pth.endswith(".py") or ".py:" in pth or "/" in pth or "\\" in pth:
+                # This is a system path. Normalize it, make it absolute relative to config file path.
+                pth = os.path.abspath(os.path.join(base_path, pth))
 
             if options is not None:
                 normalized.append({pth: options})

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/src/mkdocstrings_handlers/python/rendering.py

@@ -6,6 +6,7 @@ import enum
 import random
 import re
 import string
+import subprocess
 import sys
 import warnings
 from functools import lru_cache
@@ -71,11 +72,11 @@ order_map = {
 
 
 def do_format_code(code: str, line_length: int) -> str:
-    """Format code using Black.
+    """Format code.
 
     Parameters:
         code: The code to format.
-        line_length: The line length to give to Black.
+        line_length: The line length.
 
     Returns:
         The same code, formatted.
@@ -83,7 +84,7 @@ def do_format_code(code: str, line_length: int) -> str:
     code = code.strip()
     if len(code) < line_length:
         return code
-    formatter = _get_black_formatter()
+    formatter = _get_formatter()
     return formatter(code, line_length)
 
 
@@ -118,7 +119,7 @@ def _format_signature(name: Markup, signature: str, line_length: int) -> str:
     # Black cannot format names with dots, so we replace
     # the whole name with a string of equal length
     name_length = len(name)
-    formatter = _get_black_formatter()
+    formatter = _get_formatter()
     formatable = f"def {'x' * name_length}{signature}: pass"
     formatted = formatter(formatable, line_length)
 
@@ -137,13 +138,13 @@ def do_format_signature(
     annotations: bool | None = None,
     crossrefs: bool = False,  # noqa: ARG001
 ) -> str:
-    """Format a signature using Black.
+    """Format a signature.
 
     Parameters:
         context: Jinja context, passed automatically.
         callable_path: The path of the callable we render the signature of.
         function: The function we render the signature of.
-        line_length: The line length to give to Black.
+        line_length: The line length.
         annotations: Whether to show type annotations.
         crossrefs: Whether to cross-reference types in the signature.
 
@@ -169,6 +170,7 @@ def do_format_signature(
             language="python",
             inline=False,
             classes=["doc-signature"],
+            linenums=False,
         ),
     )
 
@@ -198,13 +200,13 @@ def do_format_attribute(
     *,
     crossrefs: bool = False,  # noqa: ARG001
 ) -> str:
-    """Format an attribute using Black.
+    """Format an attribute.
 
     Parameters:
         context: Jinja context, passed automatically.
         attribute_path: The path of the callable we render the signature of.
         attribute: The attribute we render the signature of.
-        line_length: The line length to give to Black.
+        line_length: The line length.
         crossrefs: Whether to cross-reference types in the signature.
 
     Returns:
@@ -230,6 +232,7 @@ def do_format_attribute(
             language="python",
             inline=False,
             classes=["doc-signature"],
+            linenums=False,
         ),
     )
 
@@ -432,12 +435,59 @@ def do_filter_objects(
 
 
 @lru_cache(maxsize=1)
-def _get_black_formatter() -> Callable[[str, int], str]:
+def _get_formatter() -> Callable[[str, int], str]:
+    for formatter_function in [
+        _get_black_formatter,
+        _get_ruff_formatter,
+    ]:
+        if (formatter := formatter_function()) is not None:
+            return formatter
+
+    logger.info("Formatting signatures requires either Black or Ruff to be installed.")
+    return lambda text, _: text
+
+
+def _get_ruff_formatter() -> Callable[[str, int], str] | None:
+    try:
+        from ruff.__main__ import find_ruff_bin
+    except ImportError:
+        return None
+
+    try:
+        ruff_bin = find_ruff_bin()
+    except FileNotFoundError:
+        ruff_bin = "ruff"
+
+    def formatter(code: str, line_length: int) -> str:
+        try:
+            completed_process = subprocess.run(  # noqa: S603
+                [
+                    ruff_bin,
+                    "format",
+                    "--config",
+                    f"line-length={line_length}",
+                    "--stdin-filename",
+                    "file.py",
+                    "-",
+                ],
+                check=True,
+                capture_output=True,
+                text=True,
+                input=code,
+            )
+        except subprocess.CalledProcessError:
+            return code
+        else:
+            return completed_process.stdout
+
+    return formatter
+
+
+def _get_black_formatter() -> Callable[[str, int], str] | None:
     try:
         from black import InvalidInput, Mode, format_str
     except ModuleNotFoundError:
-        logger.info("Formatting signatures requires Black to be installed.")
-        return lambda text, _: text
+        return None
 
     def formatter(code: str, line_length: int) -> str:
         mode = Mode(line_length=line_length)
@@ -592,7 +642,7 @@ def do_as_modules_section(
                 description=module.docstring.value.split("\n", 1)[0] if module.docstring else "",
             )
             for module in modules
-            if not check_public or module
+            if not check_public or module.is_public
         ],
     )
 

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

@@ -52,7 +52,7 @@ Context:
             <span class="doc doc-object-name doc-attribute-name">{{ attribute_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
-              {{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
+              {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}
               {% if attribute.value %} = {{ attribute.value }}{% endif %}
             {% endfilter %}
           {% endif %}

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

@@ -18,7 +18,7 @@ Context:
 {% endblock logs %}
 
 <div class="doc doc-object doc-class">
-  {% with obj = class, html_id = class.path %}
+  {% with obj = class, html_id = class.path, all_members = class.all_members %}
 
     {% if root %}
       {% set show_full_path = config.show_root_full_path %}
@@ -49,8 +49,8 @@ Context:
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
           {% if config.separate_signature %}
             <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
-          {% elif config.merge_init_into_class and "__init__" in class.all_members %}
-            {% with function = class.all_members["__init__"] %}
+          {% elif config.merge_init_into_class and "__init__" in all_members %}
+            {% with function = all_members["__init__"] %}
               {%+ filter highlight(language="python", inline=True) %}
                 {{ class_name }}{% include "signature"|get_template with context %}
               {% endfilter %}
@@ -76,13 +76,26 @@ Context:
         {#- Signature block.
         
         This block renders the signature for the class.
+        Overloads of the `__init__` method are rendered if `merge_init_into_class` is enabled.
+        The actual `__init__` method signature is only rendered if `separate_signature` is also enabled.
         -#}
-        {% if config.separate_signature and config.merge_init_into_class %}
-          {% if "__init__" in class.all_members %}
-            {% with function = class.all_members["__init__"] %}
-              {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
-                {{ class.name }}
-              {% endfilter %}
+        {% if config.merge_init_into_class %}
+          {% if "__init__" in all_members %}
+            {% with function = all_members["__init__"] %}
+              {% if function.overloads %}
+                <div class="doc-overloads">
+                  {% for overload in function.overloads %}
+                    {% filter format_signature(overload, config.line_length, annotations=True, crossrefs=config.signature_crossrefs) %}
+                      {{ class.name }}
+                    {% endfilter %}
+                  {% endfor %}
+                </div>
+              {% endif %}
+              {% if config.separate_signature %}
+                {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
+                  {{ class.name }}
+                {% endfilter %}
+              {% endif %}
             {% endwith %}
           {% endif %}
         {% endif %}
@@ -132,13 +145,17 @@ Context:
             {% include "docstring"|get_template with context %}
           {% endwith %}
           {% if config.merge_init_into_class %}
-            {% if "__init__" in class.all_members and class.all_members["__init__"].has_docstring %}
-              {% with function = class.all_members["__init__"] %}
-                {% with obj = function, docstring_sections = function.docstring.parsed %}
-                  {% include "docstring"|get_template with context %}
+            {# We don't want to merge the inherited `__init__` method docstring into the class docstring #}
+            {# if such inherited method was not selected through `inherited_members`. #}
+            {% with check_members = all_members if (config.inherited_members is true or (config.inherited_members is iterable and "__init__" in config.inherited_members)) else class.members %}
+              {% if "__init__" in check_members and check_members["__init__"].has_docstring %}
+                {% with function = check_members["__init__"] %}
+                  {% with obj = function, docstring_sections = function.docstring.parsed %}
+                    {% include "docstring"|get_template with context %}
+                  {% endwith %}
                 {% endwith %}
-              {% endwith %}
-            {% endif %}
+              {% endif %}
+            {% endwith %}
           {% endif %}
         {% endblock docstring %}
 
@@ -157,8 +174,8 @@ Context:
           -#}
           {% if config.show_source %}
             {% if config.merge_init_into_class %}
-              {% if "__init__" in class.all_members and class.all_members["__init__"].source %}
-                {% with init = class.all_members["__init__"] %}
+              {% if "__init__" in all_members and all_members["__init__"].source %}
+                {% with init = all_members["__init__"] %}
                   <details class="quote">
                     <summary>Source code in <code>
                       {%- if init.relative_filepath.is_absolute() -%}

{mkdocstrings_python-1.12.1 → mkdocstrings_python-1.13.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja

@@ -23,6 +23,6 @@ Context:
   {% if section_type.value == "text" %}
     {{ sub_section|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
   {% elif section_type.value == "examples" %}
-    {{ sub_section|highlight(language="pycon", linenums=False) }}
+    {{ sub_section|highlight(language="pycon") }}
   {% endif %}
 {% endfor %}