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.44.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.44-py3-none-any.whl
(26.9 kB
view details)
File details
Details for the file mdxify-0.2.44.tar.gz.
File metadata
- Download URL: mdxify-0.2.44.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1639ef18cf586b43d9a5ac5f567acdcba689f6fe73e27e50d6eca782b47b6e05
|
|
| MD5 |
4aa4aa489d786ec33a25f0d93aea4930
|
|
| BLAKE2b-256 |
08c186724b97322a5cc529472f6a6a6a0b80055473f1c85966cb608c6fa45631
|
File details
Details for the file mdxify-0.2.44-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.44-py3-none-any.whl
- Upload date:
- Size: 26.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5dc9346087022a4e2a593e0b8b47fe6c724513b0bce85e6c9d93ac573616922b
|
|
| MD5 |
89d1153ddd70cad404613b7c235a9f66
|
|
| BLAKE2b-256 |
380f7b8efe14cf4311fdb2716968c9582cadc184f4e551dac62ae7cf40e460f6
|
