mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
a4ec83a83a
- Rename fumadocs/ directory to docs/ - Update all path references in GitHub workflows - Update CODEOWNERS - Update SDK doc generation scripts output paths - Rename workflow file fumadocs-check-links.yml to docs-check-links.yml - Update package.json name to @composio/docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
718 B
718 B
SDK Documentation Generator
Generates MDX reference docs from Python source using griffe.
Usage
cd python
uv run --with griffe python scripts/generate-docs.py
How it works
- griffe extracts docstrings from
composio/**/*.py→ structured data generate-docs.pytransforms data → MDX files- Output written to
docs/content/reference/sdk-reference/python/
Configuration
- Expected classes:
EXPECTED_CLASSESdict maps class name → Composio property - Modules to search:
CLASS_MODULESlist - Decorators:
DECORATORS_TO_DOCUMENTlist
CI
.github/workflows/generate-sdk-docs.yml triggers on changes to python/composio/** and opens a PR with updated docs.