mdxify 0.2.4

Generate MDX API documentation from Python modules

mdxify

Generate MDX API documentation from Python modules with automatic navigation structure.

Installation

pip install mdxify

Usage

Generate documentation for all modules in a package:

mdxify --all --root-module mypackage --output-dir docs/api

Generate documentation for specific modules:

mdxify mypackage.core mypackage.utils --output-dir docs/api

Options

• modules: Specific modules to document
• --all: Generate documentation for all modules under the root module
• --root-module: Root module to generate docs for (required when using --all)
• --output-dir: Output directory for generated MDX files (default: docs/api)
• --update-nav/--no-update-nav: Update docs.json navigation (default: True)

Navigation Updates

To use automatic navigation updates, add a placeholder in your docs.json:

{
  "navigation": [
    {
      "group": "API Reference",
      "pages": [
        {"$mdxify": "generated"}
      ]
    }
  ]
}

mdxify will replace {"$mdxify": "generated"} with the generated module structure.

Features

• Fast AST-based parsing - No module imports required
• MDX output - Compatible with modern documentation frameworks
• Automatic navigation - Generates hierarchical navigation structure
• Google-style docstrings - Formats docstrings using Griffe
• Smart filtering - Excludes private modules and known test patterns

Development

# Install development dependencies
uv sync

# Run tests
uv run pytest

# Run type checking
uv run ty check

# Run linting
uv run ruff check src/ tests/