Skip to main content

mdxify

Generate API documentation from Python modules with automatic navigation and source links.

What is mdxify?

mdxify is a fast, AST-based documentation generator that turns Python modules into clean MDX or Markdown documentation. It’s designed to work seamlessly with documentation platforms like Mintlify.

Key Features

Fast AST Parsing

No imports needed

MDX Output

Safe escaping with GitHub source links

Auto Navigation

Automatic hierarchical navigation for Mintlify

Google Docstrings

Full support via Griffe parser

Who’s Using mdxify?

Quick Example

uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk
This generates complete API documentation for mypackage with:
  • All public modules and functions documented
  • GitHub source links for every item
  • Automatic navigation structure
  • Clean MDX formatting
I