Generate MDX API documentation from Python modules
Project description
mdxify
Generate API documentation from Python modules with automatic navigation and source links.
Projects Using mdxify
mdxify— This documentation at mdxify.zzstoatzz.io- FastMCP — API docs at gofastmcp.com/python-sdk
- Prefect — API reference at docs.prefect.io/v3/api-ref/python
Quick Start
uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk
Documentation
Features
- Fast AST-based parsing
- MDX output with safe escaping
- Automatic hierarchical navigation (Mintlify)
- Google-style docstrings via Griffe
- Smart filtering of private modules
Development
See CONTRIBUTING.md for local setup, testing, linting, and release guidance.
[!IMPORTANT] This project is not associated with the company Mintlify.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mdxify-0.2.36.tar.gz
(1.3 MB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
mdxify-0.2.36-py3-none-any.whl
(24.6 kB
view details)
File details
Details for the file mdxify-0.2.36.tar.gz.
File metadata
- Download URL: mdxify-0.2.36.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd8afc3036b8258b13cd6d44413f1805088a9959b1b2d63eae9160cc037ee8e4
|
|
| MD5 |
a1d3cc4bc018529fea597a8637243ab4
|
|
| BLAKE2b-256 |
578beec3cc2f5b9e15a1d5d1a7399cf68b420bbd7ab8c363c789cfb14f783a09
|
File details
Details for the file mdxify-0.2.36-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.36-py3-none-any.whl
- Upload date:
- Size: 24.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9dbe9b3e608ad1b9d5d95f95fcc66788d0d737a52eadd8bdb1244e628dc6d98c
|
|
| MD5 |
85ae6b8e3811ae170be63503270ccddd
|
|
| BLAKE2b-256 |
aab43ad6aac18dbd5913201cd3bbf19a896a59fd418c7e87a5abf18575fb339a
|
