Skip to content

Make the docs build successfully with mkdocstrings-python 2.0 #1575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waylan merged 1 commit into from
Dec 11, 2025
+12 −10
Merged

Make the docs build successfully with mkdocstrings-python 2.0 #1575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/templates/python/nature/attribute.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends "_base/attribute.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.relative_filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
<a class="doc-source-link" href="{{ config.extra.source.repo }}/tree/{{ config.extra.source.tag }}/{{ attribute.relative_filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
{% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
{%+ filter highlight(language="python", inline=True) %}
{{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion docs/templates/python/nature/class.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% extends "_base/class.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ class.relative_filepath }}#L{{ class.lineno }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
<a class="doc-source-link" href="{{ config.extra.source.repo }}/tree/{{ config.extra.source.tag }}/{{ class.relative_filepath }}#L{{ class.lineno }}" title="{{ config.extra.source.title }}">&lsaquo;&rsaquo;</a>
{{ super() }}
{% endblock heading %}
2 changes: 1 addition & 1 deletion docs/templates/python/nature/function.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% extends "_base/function.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ function.relative_filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
<a class="doc-source-link" href="{{ config.extra.source.repo }}/tree/{{ config.extra.source.tag }}/{{ function.relative_filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.extra.source.title }}">&lsaquo;&rsaquo;</a>
{{ super() }}
{% endblock heading %}
2 changes: 1 addition & 1 deletion docs/templates/python/nature/module.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% extends "_base/module.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ module.relative_filepath }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
<a class="doc-source-link" href="{{ config.extra.source.repo }}/tree/{{ config.extra.source.tag }}/{{ module.relative_filepath }}" title="{{ config.extra.source.title }}">&lsaquo;&rsaquo;</a>
{{ super() }}
{% endblock heading %}
11 changes: 6 additions & 5 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ plugins:
custom_templates: docs/templates
handlers:
python:
import:
inventories:
- https://docs.python.org/3/objects.inv
options:
annotations_path: brief
Expand Down Expand Up @@ -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."
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down