Quick Start

uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk

uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk

uvx mdxify mypackage.core mypackage.utils --output-dir docs/python-sdk

uvx mdxify --all --root-module mypackage \
  --exclude mypackage.internal --exclude mypackage.tests

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

# Generate API reference documentation
api-ref:
    uvx --with-editable . \
        mdxify \
        --all \
        --root-module mypackage \
        --output-dir docs/python-sdk \
        --repo-url https://github.com/owner/repo

# Generate docs for specific modules
api-ref-modules *MODULES:
    uvx mdxify {{MODULES}} \
        --root-module mypackage \
        --output-dir docs/python-sdk

name: Auto-generate documentation

on:
  push:
    branches: [main]
    paths:
      - "src/**/*.py"
      - ".github/workflows/auto-generate-docs.yaml"

permissions:
  contents: write
  pull-requests: write

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: astral-sh/setup-uv@v6
      - uses: extractions/setup-just@v3
      
      - name: Generate docs
        run: just api-ref
      
      - name: Check for changes
        id: check-changes
        run: |
          if git diff --quiet; then
            echo "has_changes=false" >> $GITHUB_OUTPUT
          else
            echo "has_changes=true" >> $GITHUB_OUTPUT
          fi
      
      - name: Create PR if changes
        if: steps.check-changes.outputs.has_changes == 'true'
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          
          BRANCH="auto-docs-$(date +%Y%m%d-%H%M%S)"
          git checkout -b "$BRANCH"
          git add .
          git commit -m "docs: auto-update API reference"
          git push origin "$BRANCH"
          
          gh pr create \
            --title "Auto-update API documentation" \
            --body "Automatically generated API documentation updates" \
            --label "documentation"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

uvx mdxify --all --root-module mypackage \
  --repo-url https://github.com/owner/repo --branch develop