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.42.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.42-py3-none-any.whl
(26.2 kB
view details)
File details
Details for the file mdxify-0.2.42.tar.gz.
File metadata
- Download URL: mdxify-0.2.42.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 |
79a362bcad86a69af47d13fd32d4f17903c954206f25a6351952ecb36db8ef2d
|
|
| MD5 |
88b66eb45d2981cff9ff5c70a2a83d93
|
|
| BLAKE2b-256 |
aeca387409b31d486fd92de6445ec62323d3b2e840854673935a56ba322dd145
|
File details
Details for the file mdxify-0.2.42-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.42-py3-none-any.whl
- Upload date:
- Size: 26.2 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 |
5e0b608a3f15d8ee77c240d4b93ba948f6fcee36baa0e86c6800b79b4f4469e0
|
|
| MD5 |
267bb931eadfcfc96bbf788897b1e33f
|
|
| BLAKE2b-256 |
d4abb06b9e404e7e4865f076a831079387f66e544475ea40a2dc0560b568aed4
|
