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.37.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.37-py3-none-any.whl
(25.2 kB
view details)
File details
Details for the file mdxify-0.2.37.tar.gz.
File metadata
- Download URL: mdxify-0.2.37.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 |
d1a49b708921bad11cbcc3e95f6a5fb69c4f065272d51ed2536454385a7c75bf
|
|
| MD5 |
3f539c0e732aa78b23830fd8540678b4
|
|
| BLAKE2b-256 |
99c953e1439c06986e1cecd36d48a70f1a256b3ff8fca71d7b8a8377873e54d3
|
File details
Details for the file mdxify-0.2.37-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.37-py3-none-any.whl
- Upload date:
- Size: 25.2 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 |
40017832f5d6d77c45eff792549964f313fe54a355393aac70e66e9a4f053b92
|
|
| MD5 |
0e264509e0f464823c1512f695fad1e4
|
|
| BLAKE2b-256 |
c592dcdf05aa6ca14deaf73dd08f7701b08100692ade593f91d07a5a3fd58e57
|
