Add Support for PEP 695 Generics

[jonathan-laurent]

Context

Griffe recently added support for PEP 695 generics. It would b useful for mkdocs-material to support them too.

Description

There are mainly two features that would be worth having:

Documenting type aliases

Currently, trying to include documentation to type aliases (type MyAlias = ...) leads to a runtime exception:

jinja2.exceptions.UndefinedError: 'type_alias' is undefined

In a recent past version, the type_alias.html.jinja template was missing altogether so I imagine this is currently being worked on.

Adding support for "Type Parameters" Sections on Docstrings

Currently, these sections are not shown.

Related links

• Griffe Support for PEP 695 Generics

Use Cases

PEP 695 generics are seeing increasing adoption (since Python 3.12) and require specific mkdocs-material support.

Visuals

No response

Before submitting

• I have read and followed the change request guidelines.
• I have verified that my idea is a change request and not a bug report.
• I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
• I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.

[pawamoy]

Hello @jonathan-laurent, this is the responsibility of mkdocstrings, not mkdocs-material, and we published version 1.18 a couple days ago with support for PEP 695 🙂 If you find that something isn't working as expected, please open a new issue here: https://github.com/mkdocstrings/python/issues. In the meantime I believe this very issue can be closed.

[jonathan-laurent]

@pawamoy Thanks for your comment. I was misled by the mention of material in the name of one of the faulty templates:

mkdocstrings_handlers/python/templates/material/_base/type_alias.html.jinja

I'll look at this again and open a new issue if needed.