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.41.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.41-py3-none-any.whl
(26.0 kB
view details)
File details
Details for the file mdxify-0.2.41.tar.gz.
File metadata
- Download URL: mdxify-0.2.41.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 |
cdc8c7e8800a1f5bb17e9afd9438fc697845f5400a2b759baaa960f4dda03378
|
|
| MD5 |
2f9f564177f16768698158b63159f1cf
|
|
| BLAKE2b-256 |
280c59396e4cb35e12cb3c9b8ab6be023756883eacbfda6f4db63d16e71c1914
|
File details
Details for the file mdxify-0.2.41-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.41-py3-none-any.whl
- Upload date:
- Size: 26.0 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 |
bc315308e9d964976444fe8eda0bb79d577372b5bf45fca96aff155656b24751
|
|
| MD5 |
cd7a2b88fa39c93967d42029a72c219a
|
|
| BLAKE2b-256 |
02bc791c496a551633b77cb9fb5fb28907d4fea7a30873c63e232f0b51121fc2
|
