griffe2md
Output API docs to Markdown using Griffe.
Decision gist · record as of 2026-08-14
Yes. Low install friction, active maintenance, no known vulnerabilities, and a permissive license make it a straightforward choice. Install it if you need to generate Markdown API docs from Python packages; the command-line interface is simple and the configuration is minimal.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low friction install with a pure Python wheel.
- Actively maintained with recent releases; last commit 2026-03-12 and marked as active status.
License · maintenance · safety
ISC (permissive) — ISC license is permissive, allowing commercial and private use with minimal restrictions.
last release 2026-03-12 (155 days) · last repo commit 2026-03-12 · 18 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 276,930 downloads/mo, #8,154 on PyPI
Alternatives
Verify before relying
pip install griffe2md
griffe2md package_name -o docs.md- Whether Griffe's static analysis covers all Python docstring formats beyond the documented sphinx style
- Performance characteristics when processing large or deeply nested packages
What it is and what it does
griffe2md is a command-line tool that converts Python package API documentation into Markdown files. It uses Griffe, a static analysis library, to parse your package's structure and docstrings, then renders them as formatted Markdown suitable for documentation sites or repositories. The tool supports multiple docstring styles (configurable via pyproject.toml or griffe2md.toml) and can output to stdout or directly to a file.
You run it by pointing it at a package name or folder path, and it generates structured Markdown with your API's classes, functions, and their documentation. It's designed for developers who want to maintain API docs in Markdown format without manually writing or updating them, integrating easily into documentation workflows alongside tools like mdformat for consistent formatting.
Use it for
- Generate API reference documentation for a Python package to include in a README or docs site
- Automate API doc generation in CI/CD pipelines to keep docs in sync with code changes
- Convert existing docstrings to Markdown format for migration to a new documentation system
- Create Markdown API docs for packages that use Sphinx-style docstrings without needing Sphinx itself
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Low install friction, active maintenance, no known vulnerabilities, and a permissive license make it a straightforward choice. Install it if you need to generate Markdown API docs from Python packages; the command-line interface is simple and the configuration is minimal.
Install
griffe2md on PyPI
Before you install
Low friction install with a pure Python wheel. Actively maintained with recent releases; last commit 2026-03-12 and marked as active status.
Requires Python 3.10 or later.
License in practice
ISC license is permissive, allowing commercial and private use with minimal restrictions.
Quickstart
pip install griffe2md
griffe2md package_name -o docs.mdVerify before relying
- Whether Griffe's static analysis covers all Python docstring formats beyond the documented sphinx style
- Performance characteristics when processing large or deeply nested packages
Package facts
| License | ISC permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesgriffelibjinja2mdformattomli |
| Maintenance | Actively maintained 155 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 276,930 / month, #8,154 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software DevelopmentTopic :: UtilitiesTyping :: Typed |
Evidence: griffe2md-1.5.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “generate markdown api docs”
- griffe2mdGenerates Markdown API documentation from Python packages using…
- pydoc-markdownPydoc-Markdown parses Python source code and generates API…
- haystack-pydoc-toolsGenerates Docusaurus-compatible Markdown API documentation from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also griffe-pydantic · mkdocstrings-python · griffe · haystack-pydoc-tools · griffe-warnings-deprecated · mkdocstrings · sphinx-autodoc2 · mkdocs-api-autonav · griffe-typingdoc · mkdocstrings-python-legacy