⚠️ mkdocstrings-python is in maintenance mode

[pawamoy]

Since the announcement of Zensical, mkdocstrings and first-party handlers (Python, Crystal, Shell, TypeScript, C) have implicitly been put in maintenance mode. I'm now part of the Zensical team, and so will be putting my time there instead of MkDocs. This announcement makes maintenance mode official.

Maintenance mode means that new features won't be implemented, but bug fixes will still be merged and released, so PRs fixing bugs are still welcome (and I will myself continue fixing bugs of course).

mkdocstrings will be maintained at least until the end of 2026, at which point we'll either:

• push back the end date if needed
• officially endorse new maintainers
• archive the project

Thank you for your support! I hope to see you on the Zensical side 😄!

[pawamoy]

Non-bug issues still opened at the time of entering maintenance mode:

• feature: include non-local superclasses in mermaid inheritance diagram #318
• feature: make show_docstring_description further customizable #303
• bug: PEP695 type MyAlias = int not included in docs while MyAlias: TypeAlias = int works fine #298
• feature: Custom category ordering #274
• feature: Support enabling signature_crossrefs without enabling separate_signature #270
• feature: Setting to have codeblocks un-collapsed as default #259
• feature: Option to link source #253
• Docstring not showing when using the type statement.  #247
• feature: Support for accessors #230
• feat: Show member summary but not the members themselves #226
• feature: Inform users when local option has no effect #214
• feature: Manually specify external docs url for docs without objects.inv #198
• feature: Include all subclasses using a simple API command #184
• feature: prevent overflow for long object names/headings #177
• feature: highlight functions decorated with @deprecated #171
• feature: Add option to filter out imported objects (true by default for backward compatibility) #170
• feature: link to re-export instead of inserting full documentation #167
• feature: Allow filtering objects in templates thanks to labels #164
• feature: Filter shown base classes #161
• feature: Show all classes in inheritance diagrams, not just the ones that can be resolved in the current project #154
• feature: Warn about attributes sections found in __init__ method docstrings #144
• Unable to get docstring summary, and supress the remainder of the docstring #139
• feature: warn for type alias without docstring #138
• feature: Improve rendering of function overloads #135
• feat: Option to generate headings (+ ToC entries) for items in summary tables (attributes, functions/methods, classes, modules) #133
• feature: Add an option: show_docstring_summary: false #113
• Support .pyx files #104
• Omit docstring from show_source #93
• Suggestion: Add option to expand Literals #73

[ofek]

Without committing to a roadmap, can you please explain at a high level what the plan is to support API documentation in Zensical? We would never be able to migrate without the ability to render documentation for our code.

[pawamoy]

Sure, thanks for asking. The plan is to bring preliminary support for mkdocstrings in Zensical, to maximize compatibility and ease migration. We'll then rework API documentation from the ground up (spoiler: we already put some hours into it), while moving more and more parts from mkdocstrings into Zensical, as the module system stabilizes. All the experience, feedback, and feature requests obtained through mkdocstrings will be put to good use within Zensical to bring first-class support for API docs, and more 🙂

[ofek]

For posterity: https://github.com/zensical/zensical/releases/tag/0.0.11