-
Notifications
You must be signed in to change notification settings - Fork 708
Replace unmaintained pydoc-markdown #1753
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentation.Improvements or additions to documentation.t-toolingIssues with this label are in the ownership of the tooling team.Issues with this label are in the ownership of the tooling team.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentation.Improvements or additions to documentation.t-toolingIssues with this label are in the ownership of the tooling team.Issues with this label are in the ownership of the tooling team.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Problem
pydoc-markdown is unmaintained (last supported Python version is 3.11, never left alpha stage). The author recommends switching to mkdocstrings.
This causes:
pydoc-markdownonly as an intermediate step, with custom JS glue code on top to produce Docusaurus-compatible formatCurrent setup
pydoc-markdown→ Markdown → custom JS glue code → Docusaurus-compatible outputOptions
Option 3 is the preferred long-term solution — a focused open-source tool that fills the gap in Python doc tooling for Docusaurus.
References