mkdocstrings/mkdocstrings

Health v2 · maintenance only

Adoption not part of the score

2085 stars · 125 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

mkdocstrings is an MkDocs plugin that automatically generates API documentation from source code docstrings, supporting multiple languages via handlers (Python, C, TypeScript, Shell, and more). It injects documentation into Markdown pages and supports cross-references, multiple themes, and global/local configuration.

Use cases

• generate api docs from python docstrings
• document a python library with mkdocs
• auto-generate documentation from source code
• add api reference pages to mkdocs site
• cross-reference code objects across documentation pages
• document shell scripts or c code with mkdocs

When to choose

• you already use MkDocs and want automatic API documentation
• you want docstring-driven docs with Material theme support
• you need cross-referencing of API items across pages or sites

When to avoid

• you use Sphinx or prefer a non-MkDocs documentation toolchain
• you need a language without an available handler
• you want actively developed new features, since the project is in maintenance mode

Facets

plugin · maturity maintenance

documentation markdown parser documentation developer-tools web-development python cli mkdocs mkdocs-plugin docstrings autodoc api-documentation static-site-generator

Member repositories

For agents

markdown · JSON · MCP: product_card(name="mkdocstrings/mkdocstrings")