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.34.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.34-py3-none-any.whl
(23.4 kB
view details)
File details
Details for the file mdxify-0.2.34.tar.gz.
File metadata
- Download URL: mdxify-0.2.34.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 |
00efbed4657ddad5f6eca8631acea9a04ef5b7820a315e7d362a43c086a6de61
|
|
| MD5 |
688a4de6af770066bddd4702ac2c7622
|
|
| BLAKE2b-256 |
c057d2fe462ff2fb99356d6c7fbdbb1adcfade0d0388bbd638009ef5cca59f60
|
File details
Details for the file mdxify-0.2.34-py3-none-any.whl.
File metadata
- Download URL: mdxify-0.2.34-py3-none-any.whl
- Upload date:
- Size: 23.4 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 |
655c73baec7b130327bc0def5e1ecdd6163ba59d57b1f4fe3e1b4733d13e01db
|
|
| MD5 |
3d7108daceb49f812e344dcba1798029
|
|
| BLAKE2b-256 |
dbff3d2be4ace2c1d3631306e3e44e066ddd3eade32a20d820182346efee715f
|
