diff --git a/docs/changelog.md b/docs/changelog.md index 25ff4047a..4311353fb 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -15,6 +15,7 @@ See the [Contributing Guide](contributing.md) for details. ### Fixed * Ensure nested elements inside inline comments are properly unescaped (#1571). +* Make the docs build successfully with mkdocstrings-python 2.0 (#1575). ## [3.10.0] - 2025-11-03 diff --git a/docs/templates/python/nature/attribute.html.jinja b/docs/templates/python/nature/attribute.html.jinja index a40d6728c..44dc11d4f 100644 --- a/docs/templates/python/nature/attribute.html.jinja +++ b/docs/templates/python/nature/attribute.html.jinja @@ -1,7 +1,7 @@ {% extends "_base/attribute.html.jinja" %} {% block heading scoped %} - ‹› + ‹› {% if config.show_symbol_type_heading %}{% endif %} {%+ filter highlight(language="python", inline=True) %} {{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %} diff --git a/docs/templates/python/nature/class.html.jinja b/docs/templates/python/nature/class.html.jinja index 4cf19ec8d..4076aa909 100644 --- a/docs/templates/python/nature/class.html.jinja +++ b/docs/templates/python/nature/class.html.jinja @@ -1,6 +1,6 @@ {% extends "_base/class.html.jinja" %} {% block heading scoped %} - ‹› + ‹› {{ super() }} {% endblock heading %} diff --git a/docs/templates/python/nature/function.html.jinja b/docs/templates/python/nature/function.html.jinja index 8bbca47d8..c2f4b2caf 100644 --- a/docs/templates/python/nature/function.html.jinja +++ b/docs/templates/python/nature/function.html.jinja @@ -1,6 +1,6 @@ {% extends "_base/function.html.jinja" %} {% block heading scoped %} - ‹› + ‹› {{ super() }} {% endblock heading %} diff --git a/docs/templates/python/nature/module.html.jinja b/docs/templates/python/nature/module.html.jinja index 465ef1d9f..f6b99bb17 100644 --- a/docs/templates/python/nature/module.html.jinja +++ b/docs/templates/python/nature/module.html.jinja @@ -1,6 +1,6 @@ {% extends "_base/module.html.jinja" %} {% block heading scoped %} - ‹› + ‹› {{ super() }} {% endblock heading %} diff --git a/mkdocs.yml b/mkdocs.yml index 92f6ccc80..a88d8c12f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,7 +81,7 @@ plugins: custom_templates: docs/templates handlers: python: - import: + inventories: - https://docs.python.org/3/objects.inv options: annotations_path: brief @@ -113,7 +113,8 @@ plugins: show_symbol_type_toc: false signature_crossrefs: false summary: true - source: - repo: https://github.com/Python-Markdown/markdown - tag: !!python/name:markdown.__version__ - title: "View source code on GitHub." + extra: + source: + repo: https://github.com/Python-Markdown/markdown + tag: !!python/name:markdown.__version__ + title: "View source code on GitHub." diff --git a/pyproject.toml b/pyproject.toml index 9b083bbe4..b539dd951 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,7 +53,7 @@ docs = [ 'mkdocs>=1.6', 'mkdocs-nature>=0.6', 'mdx_gh_links>=0.2', - "mkdocstrings[python]", + "mkdocstrings[python]>=0.28.3", "mkdocs-gen-files", "mkdocs-section-index", "mkdocs-literate-nav",