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.38.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.38-py3-none-any.whl
(25.1 kB
view details)
File details
Details for the file mdxify-0.2.38.tar.gz.
File metadata
- Download URL: mdxify-0.2.38.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 |
6d228be177b200a19c3426b1936fdcfabe0d6089072136f44b3695e6abab2c49
|
|
| MD5 |
f6146bcc2c6c96ff7c0dae23ee51c0f0
|
|
| BLAKE2b-256 |
47e7a827392af6a30d52fd7949a3b53dc06f64f67f4f381b3d6d45d8e4bd5a20
|
File details
Details for the file mdxify-0.2.38-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.38-py3-none-any.whl
- Upload date:
- Size: 25.1 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 |
71cbadfb65e4af22472d333b5ea7f723d1051a9bd5a448b8399ee6d36efefa6e
|
|
| MD5 |
5532250b2d992c94be82407ad15467f5
|
|
| BLAKE2b-256 |
3c948057470164213ac74e5a3208a13ea38f424e352f08f1007e7a3b9e7f767f
|
