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
?
mdxify
— This documentation’s api reference!- FastMCP — API docs at gofastmcp.com/python-sdk
- Prefect — API reference at docs.prefect.io/v3/api-ref/python
Quick Example
mypackage
with:
- All public modules and functions documented
- GitHub source links for every item
- Automatic navigation structure
- Clean MDX formatting