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.39.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.39-py3-none-any.whl
(25.5 kB
view details)
File details
Details for the file mdxify-0.2.39.tar.gz.
File metadata
- Download URL: mdxify-0.2.39.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 |
37998d9bab229a7f44da3cdc79b4977ba395aa89f755fec60fd173114af80f35
|
|
| MD5 |
3ef4e0184e4d3369af6dc5dbcf15bfed
|
|
| BLAKE2b-256 |
5de48e434bca826fc0ba99151f7e08d6756471dcae91a670082fd819d70dfc10
|
File details
Details for the file mdxify-0.2.39-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.39-py3-none-any.whl
- Upload date:
- Size: 25.5 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 |
8c56c9914a5802e69e982147bc454803a1e1723aa38358a226110eb8c2e6a1b0
|
|
| MD5 |
9901bfbdc69735a9db1f054dd22a7b3d
|
|
| BLAKE2b-256 |
2a7adce191af51aa75a8ca12dee586e4dab2bac5da2ec294768cf579fec517da
|
