v0.2.4

What's Changed

• fix: match navigation paths to actual generated filenames by @zzstoatzz in cc72b64

Bug Fixes

• Navigation entries now correctly reference the actual generated filenames
• Fixed issue where navigation looked for 'fastmcp-cli' but the actual file was 'fastmcp-cli-init.mdx'
• Navigation builder now checks if a module has submodules to determine the correct filename pattern

Full Changelog: v0.2.3...v0.2.4

v0.2.3

What's Changed

• fix: include all modules in hierarchical navigation structure by @zzstoatzz in 46881c4

Bug Fixes

• Navigation entries now correctly include directory prefixes (e.g., 'api/fastmcp-cli' instead of just 'fastmcp-cli')
• All modules now processed through same hierarchical tree structure for consistent path handling
• Root package modules properly included in navigation output

Full Changelog: v0.2.2...v0.2.3

v0.2.2 - Fix Navigation Paths

Fixes

• Navigation entries now include proper relative paths from the docs root (e.g., api-reference/fastmcp instead of just fastmcp)
• Root modules (single-part names like fastmcp) are now included in navigation output
• Works correctly with Mintlify and other documentation frameworks that need full paths to MDX files

Example

If your MDX files are in docs/api-reference/:

• File: docs/api-reference/fastmcp.mdx
• Navigation entry: "api-reference/fastmcp"

Installation

pip install mdxify==0.2.2

Or with uvx:

uvx mdxify@0.2.2 --help

v0.2.1 - Fix Navigation Updates

Fixes

• Navigation updates now use a placeholder-based system instead of hardcoded Prefect-specific structure
• Shows helpful error message when placeholder is missing from docs.json
• Works with any documentation framework that uses JSON navigation (FastMCP, Mintlify, etc.)

How to Use Navigation Updates

Add this placeholder in your docs.json where you want the API docs to appear:

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

mdxify will replace the placeholder with your generated module structure.

Installation

pip install mdxify==0.2.1

Or with uvx:

uvx mdxify@0.2.1 --help

v0.2.0 - Generic Package Support

Breaking Changes

• --root-module is now required when using --all flag
• Default output directory changed from docs/v3/api-ref to docs/api

What's Changed

Features

• mdxify is now completely generic and works with any Python package
• Removed all Prefect-specific assumptions and hardcoded paths
• Improved module filtering to exclude common test patterns (test, tests, testing)
• Better error messages when required arguments are missing

Fixes

• Navigation building no longer assumes specific directory structures
• Fixed import organization in generated _version.py file

Installation

pip install mdxify==0.2.0

Or with uvx:

uvx mdxify@0.2.0 --help

Example Usage

# Generate docs for your entire package
uvx mdxify --all --root-module mypackage --output-dir docs/api

# Generate docs for specific modules
uvx mdxify mypackage.core mypackage.utils --output-dir docs/api

v0.1.0a1 (alpha)

Initial alpha pre-release for testing

What's New

• Modularized library structure
• Fast AST-based parsing
• MDX output generation
• Automatic navigation building
• CLI interface

Installation

pip install --pre mdxify