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.45.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.45-py3-none-any.whl
(26.2 kB
view details)
File details
Details for the file mdxify-0.2.45.tar.gz.
File metadata
- Download URL: mdxify-0.2.45.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 |
60a87a324c5b1387b937aafb50eed0214230c477f8463c24583a2a0d1a684158
|
|
| MD5 |
dd8d3c93daaad48b06f6abb0398b0dc3
|
|
| BLAKE2b-256 |
16a390af4b42d04898feb2904e014e800054f64c774128007cea4212768b10c9
|
File details
Details for the file mdxify-0.2.45-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.45-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 |
7f0907cc03b2cddcb61b2be236a591c179f6f88ac4c0323e1445ee7e503417d1
|
|
| MD5 |
a8da6d3b983d50ba0b280ab09520e858
|
|
| BLAKE2b-256 |
e1df372e977d8b21e69c25257f357bb56f973ff36c402142b99c9bacae6e9488
|
