@devries-cameron20 / composio-1 / commits / 926a5d38a
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

docs: add README for Python SDK docs generator

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 6, 2026 at 18:45 UTC 926a5d38a0e95a662d0efe1aa6668b73d36ec3d7
1 file changed +26
python/scripts/README.md new
+26
@@ -0,0 +1,26 @@
1 +# SDK Documentation Generator
2 +
3 +Generates MDX reference docs from Python source using griffe.
4 +
5 +## Usage
6 +
7 +```bash
8 +cd python
9 +uv run --with griffe python scripts/generate-docs.py
10 +```
11 +
12 +## How it works
13 +
14 +1. griffe extracts docstrings from `composio/**/*.py` → structured data
15 +2. `generate-docs.py` transforms data → MDX files
16 +3. Output written to `fumadocs/content/reference/sdk-reference/python/`
17 +
18 +## Configuration
19 +
20 +- **Expected classes**: `EXPECTED_CLASSES` dict maps class name → Composio property
21 +- **Modules to search**: `CLASS_MODULES` list
22 +- **Decorators**: `DECORATORS_TO_DOCUMENT` list
23 +
24 +## CI
25 +
26 +`.github/workflows/generate-sdk-docs.yml` triggers on changes to `python/composio/**` and opens a PR with updated docs.