# mkdocstrings/mkdocstrings

:blue_book: Automatic documentation from sources, for MkDocs.

Repository: https://github.com/mkdocstrings/mkdocstrings
Canonical: https://ross.abutalabs.com/products/mkdocstrings
Homepage: https://mkdocstrings.github.io/
Language: Python
License: ISC
License Family: permissive
Topics: mkdocs, mkdocs-plugin, python, docstrings, autodoc, mkdocstrings, material-theme
Last push: 2026-07-11T19:37:56+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 92, release rhythm 92, longevity 100
- inputs: {"age_days": 2459, "days_push": 53, "days_rel": 53, "gap_med": 27, "n_releases_24m": 18}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2085, forks 125 (observed 2026-08-28T04:06:11.936227+00:00)

## What it is
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
- artifact type: plugin
- maturity: maintenance
- function: documentation, markdown, parser
- domain: documentation, developer-tools, web-development
- platform: python, cli
- tags: mkdocs, mkdocs-plugin, docstrings, autodoc, api-documentation, static-site-generator

## Member repositories
- mkdocstrings/mkdocstrings (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:11.936227+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:55:50.712912+00:00, confidence not recorded.
  - readme: https://github.com/mkdocstrings/mkdocstrings (fetched 2026-08-28T04:06:11.936227+00:00, sha 5c4f3ff59212)
  - homepage: https://mkdocstrings.github.io/ (fetched 2026-08-29T10:35:49.769212+00:00, sha 1e84e679a7bd)
  - registry_pypi: https://pypi.org/pypi/mkdocstrings/json (fetched 2026-08-29T10:35:49.778622+00:00, sha b2a86162dee9)
- Data as of 2026-08-30T08:39:29.467469+00:00.