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.43.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.43-py3-none-any.whl
(26.6 kB
view details)
File details
Details for the file mdxify-0.2.43.tar.gz.
File metadata
- Download URL: mdxify-0.2.43.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 |
a164f4dddcae59e5b19a942e6dac7e9692a491225cd57f6fd8c2aa038de4587e
|
|
| MD5 |
cada13c058f50f75ec6b74645546a390
|
|
| BLAKE2b-256 |
1f40e5014233b063593352cffb3e6e6a858eeea1800cded404fe8e77357bcc32
|
File details
Details for the file mdxify-0.2.43-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.43-py3-none-any.whl
- Upload date:
- Size: 26.6 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 |
3f2fde1c521a27c5fe19a362e823e73fc5068c7c537be45c68b9577bb6a60947
|
|
| MD5 |
e0e009da010e5feb06f3378fa681b587
|
|
| BLAKE2b-256 |
18a2093e4a8ea27779a91e81e57f3bc6ff94a89e9ac42d5dd9ef1549e566aa2c
|
