@devries-cameron20 / composio Mirror · read-only
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.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 03:37 UTC

next
md 26 lines 896 Bytes
Rendered Raw
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 --frozen --only-group docs-reference 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 `docs/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/docs-sdk-reference-drift.yml` regenerates the reference on PRs to `next` that change `python/composio/**` or this generator, and fails if the committed output differs. `griffe` is pinned in the `docs-reference` dependency group in `python/pyproject.toml`.