Skip to content

Support PEP 695 generics #221

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
pawamoy merged 20 commits into from
Aug 26, 2025
Merged

Support PEP 695 generics #221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a373895
Highlight class name in heading
viccie30 Dec 30, 2024
68fe870
Add support for PEP 695 type parameters and type aliases
viccie30 Jan 5, 2025
d481df3
Merge branch 'main' into type-parameters
pawamoy Aug 19, 2025
ad38d84
style: Format
pawamoy Aug 19, 2025
77f23ea
fixup
pawamoy Aug 20, 2025
7e12644
fixup
pawamoy Aug 24, 2025
952472e
merge class/init parameters
pawamoy Aug 26, 2025
aa40d2d
dont merge class/init type params, only render init ones
pawamoy Aug 26, 2025
b58b601
clean up
pawamoy Aug 26, 2025
b94198d
fixup
pawamoy Aug 26, 2025
79966ca
fixup
pawamoy Aug 26, 2025
c44c708
Merge branch 'main' into type-parameters
pawamoy Aug 26, 2025
0c1dc05
fixup
pawamoy Aug 26, 2025
b4b0825
Apply suggestion from @pawamoy
pawamoy Aug 26, 2025
ed71e5c
fixup
pawamoy Aug 26, 2025
46605f0
fixup
pawamoy Aug 26, 2025
d099112
fixup
pawamoy Aug 26, 2025
9fd859f
fixup
pawamoy Aug 26, 2025
73f3d76
fixup
pawamoy Aug 26, 2025
2593225
fixup
pawamoy Aug 26, 2025
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
Prev Previous commit
Next Next commit
fixup
  • Loading branch information
@pawamoy
pawamoy committed Aug 20, 2025
commit 77f23ea14539c249d9abae1575fe80c2072ed958
7 changes: 3 additions & 4 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/type_aliases.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{# YORE: Bump 2: Remove file. #}
{% extends "_base/docstring/type_aliases.html.jinja" %}

{% block logs scoped %}
{{ super() }}
{# TODO: Switch to a warning after some time. #}
{{ log.info(
"DeprecationWarning: Extending '_base/docstring/type_aliases.html' is deprecated, extend '_base/docstring/type_aliases.html.jinja' instead. " ~
"After some time, this message will be logged as a warning, causing strict builds to fail.",
{{ log.warning(
"DeprecationWarning: Extending '_base/docstring/type_aliases.html' is deprecated, extend '_base/docstring/type_aliases.html.jinja' instead. ",
once=True,
) }}
{% endblock logs %}
7 changes: 3 additions & 4 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{# YORE: Bump 2: Remove file. #}
{% extends "_base/docstring/type_parameters.html.jinja" %}

{% block logs scoped %}
{{ super() }}
{# TODO: Switch to a warning after some time. #}
{{ log.info(
"DeprecationWarning: Extending '_base/docstring/type_parameters.html' is deprecated, extend '_base/docstring/type_parameters.html.jinja' instead. " ~
"After some time, this message will be logged as a warning, causing strict builds to fail.",
{{ log.warning(
"DeprecationWarning: Extending '_base/docstring/type_parameters.html' is deprecated, extend '_base/docstring/type_parameters.html.jinja' instead. ",
once=True,
) }}
{% endblock logs %}
14 changes: 6 additions & 8 deletions ...kdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ Context:
{#- Language module providing the `t` translation method. -#}

{% with %}
{% set is_merged_init = obj.is_function and obj.name == "__init__" and config.merge_init_into_class %}

{% if config.docstring_section_style == "table" %}
{% block table_style scoped %}
{#- Block for the `table` section style. -#}
<p><span class="doc-section-title">{{ section.title or lang.t("Type Parameters:") if not is_merged_init else lang.t("<code>__init__</code> Type Parameters:") }}</span></p>
<p><span class="doc-section-title">{{ section.title or lang.t("Type Parameters:") }}</span></p>
<table>
<thead>
<tr>
Expand All @@ -42,7 +40,7 @@ Context:
{% filter heading(
heading_level + 1,
role="typeparam",
id=obj.path ~ ":" ~ type_parameter.name,
id=obj.path ~ "[" ~ type_parameter.name ~ "]",
class="doc doc-heading doc-heading-type_parameter",
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,
) %}
Expand Down Expand Up @@ -81,15 +79,15 @@ Context:
{% elif config.docstring_section_style == "list" %}
{% block list_style scoped %}
{#- Block for the `list` section style. -#}
<p><span class="doc-section-title">{{ section.title or lang.t("Type Parameters:") if not is_merged_init else lang.t("<code>__init__</code> Type Parameters:") }}</span></p>
<p><span class="doc-section-title">{{ section.title or lang.t("Type Parameters:") }}</span></p>
<ul>
{% for type_parameter in section.value %}
<li class="doc-section-item field-body">
{% if config.type_parameter_headings %}
{% filter heading(
heading_level + 1,
role="typeparam",
id=obj.path ~ ":" ~ type_parameter.name ,
id=obj.path ~ "[" ~ type_parameter.name ~ "]",
class="doc doc-heading doc-heading-type_parameter",
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,
) %}
Expand Down Expand Up @@ -130,7 +128,7 @@ Context:
<table>
<thead>
<tr>
<th><span class="doc-section-title">{{ (section.title or lang.t("TYPE PARAMETER")).rstrip(":").upper() if not is_merged_init else lang.t("<code>__init__</code> TYPE PARAMETER") }}</span></th>
<th><span class="doc-section-title">{{ (section.title or lang.t("TYPE PARAMETER")).rstrip(":").upper() }}</span></th>
<th><span>{{ lang.t("DESCRIPTION") }}</span></th>
</tr>
</thead>
Expand All @@ -142,7 +140,7 @@ Context:
{% filter heading(
heading_level + 1,
role="typeparam",
id=obj.path ~ ":" ~ type_parameter.name ,
id=obj.path ~ "[" ~ type_parameter.name ~ "]"
class="doc doc-heading doc-heading-type_parameter",
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,
) %}
Expand Down
2 changes: 0 additions & 2 deletions src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@
"Type Aliases:": "Type Aliases:",
"TYPE ALIAS": "TYPE ALIAS",
"Type Parameters:": "Type Parameters:",
"<code>__init__</code> Type Parameters:": "<code>__init__</code> Type Parameters:"|safe,
"TYPE PARAMETER": "TYPE PARAMETER",
"<code>__init__</code> TYPE PARAMETER": "<code>__init__</code> TYPE PARAMETER"|safe,
"WARNS": "WARNS",
"Warns:": "Warns:",
"YIELDS": "YIELDS",
Expand Down
7 changes: 3 additions & 4 deletions src/mkdocstrings_handlers/python/templates/material/_base/summary/type_aliases.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{# YORE: Bump 2: Remove file. #}
{% extends "_base/summary/type_aliases.html.jinja" %}

{% block logs scoped %}
{{ super() }}
{# TODO: Switch to a warning after some time. #}
{{ log.info(
"DeprecationWarning: Extending '_base/type_aliases/classes.html' is deprecated, extend '_base/type_aliases/classes.html.jinja' instead. " ~
"After some time, this message will be logged as a warning, causing strict builds to fail.",
{{ log.warning(
"DeprecationWarning: Extending '_base/type_aliases/classes.html' is deprecated, extend '_base/type_aliases/classes.html.jinja' instead.",
once=True,
) }}
{% endblock logs %}
7 changes: 3 additions & 4 deletions src/mkdocstrings_handlers/python/templates/material/_base/type_alias.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{# YORE: Bump 2: Remove file. #}
{% extends "_base/type_alias.html.jinja" %}

{% block logs scoped %}
{{ super() }}
{# TODO: Switch to a warning after some time. #}
{{ log.info(
"DeprecationWarning: Extending '_base/type_alias.html' is deprecated, extend '_base/type_alias.html.jinja' instead. " ~
"After some time, this message will be logged as a warning, causing strict builds to fail.",
{{ log.warning(
"DeprecationWarning: Extending '_base/type_alias.html' is deprecated, extend '_base/type_alias.html.jinja' instead. ",
once=True,
) }}
{% endblock logs %}
7 changes: 3 additions & 4 deletions src/mkdocstrings_handlers/python/templates/material/_base/type_parameters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{# YORE: Bump 2: Remove file. #}
{% extends "_base/type_parameters.html.jinja" %}

{% block logs scoped %}
{{ super() }}
{# TODO: Switch to a warning after some time. #}
{{ log.info(
"DeprecationWarning: Extending '_base/type_parameters.html' is deprecated, extend '_base/type_parameters.html.jinja' instead. " ~
"After some time, this message will be logged as a warning, causing strict builds to fail.",
{{ log.warning(
"DeprecationWarning: Extending '_base/type_parameters.html' is deprecated, extend '_base/type_parameters.html.jinja' instead.",
once=True,
) }}
{% endblock logs %}
2 changes: 1 addition & 1 deletion src/mkdocstrings_handlers/python/templates/material/_base/type_parameters.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Context:
{{ type_param_prefix }}
{%- if config.separate_signature and config.type_parameter_headings and config.signature_crossrefs -%}
{%- filter stash_crossref(length=type_parameter.name|length) -%}
<autoref identifier="{{ obj.path }}:{{ type_param_prefix }}{{ type_parameter.name }}" optional>{{ type_parameter.name }}</autoref>
<autoref identifier="{{ obj.path }}[{{ type_param_prefix }}{{ type_parameter.name }}]" optional>{{ type_parameter.name }}</autoref>
{%- endfilter -%}
{%- else -%}
{{ type_parameter.name }}
Expand Down
Loading