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.35.tar.gz
(1.2 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.35-py3-none-any.whl
(23.6 kB
view details)
File details
Details for the file mdxify-0.2.35.tar.gz.
File metadata
- Download URL: mdxify-0.2.35.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ef6a837ac42d2d73d4dbe49cb0af213b0e3daa5e51adf761347abb835201847
|
|
| MD5 |
816d091d1718b585db6dbfb318b1fc39
|
|
| BLAKE2b-256 |
d20a1b3d3c6d341282ca03d0d0e639aa8105ee4a9e476598eac87940b43b8878
|
File details
Details for the file mdxify-0.2.35-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.35-py3-none-any.whl
- Upload date:
- Size: 23.6 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 |
2ce361eec83263e4c693220511a2d5c25e6c43cd82e045810a78e328b206c229
|
|
| MD5 |
04918e312aecd73cf6b4397077eb2560
|
|
| BLAKE2b-256 |
b3afc20f18bb0d99ec24e88f6a6aaf9c406783489868ef287cc1f9e222f27b91
|
