Function generate_index_mdx

python/scripts/generate-docs.py:480–566

Generate index page.

(classes: list[dict], decorators: list[dict])

def generate_index_mdx(classes: list[dict], decorators: list[dict]) -> str:
    """Generate index page."""

    # Classes table
    class_rows = []
    for c in classes:
        link = f"/reference/sdk-reference/python/{slug_for(c['name'])}"
        desc = (
            c["description"][:80] + "..."
            if len(c["description"]) > 80
            else c["description"]
        )
        class_rows.append(f"| [`{display_name_for(c['name'])}`]({link}) | {desc} |")

    # Decorators section
    dec_section = ""
    if decorators:
        dec_lines = ["## Decorators", ""]
        for d in decorators:
            dec_lines.append(f"### {d['name']}")
            dec_lines.append("")
            if d["description"]:
                dec_lines.append(d["description"])
                dec_lines.append("")
            if d["source_link"]:
                dec_lines.append(f"[View source]({d['source_link']})")
                dec_lines.append("")
            # Signature
            params = ", ".join(
                f"{p['name']}: {p['type']}" + (" = ..." if p["optional"] else "")
                for p in d["parameters"]
            )
            dec_lines.append("```python")
            dec_lines.append(f"@{d['name']}({params})")
            dec_lines.append("def my_modifier(...):")
            dec_lines.append("    ...")
            dec_lines.append("```")
            dec_lines.append("")
        dec_section = "\n".join(dec_lines)

    return f"""---
title: {escape_yaml_string("Python SDK Reference")}
description: {escape_yaml_string("API reference for the Composio Python SDK")}
---

# Python SDK Reference

Complete API reference for the `composio` Python package.

## Installation

```bash
pip install composio
```

Or with uv:

```bash