mirror of https://github.com/ComposioHQ/composio.git synced 2026-09-22 11:46:35 +08:00

Files

T

History

jkomyno 3271679ee0 docs(py): render Raises sections and normalize reST in generated SDK reference

- parse :raises Exc: docstring fields (plus Sphinx synonyms) into a
  structured Raises section instead of leaking raw directives into the
  Returns description
- normalize inline reST in all rendered prose: roles (:class:, :func:,
  :meth:, ...) honor ~ short-name semantics; double-backtick literals
  become single-backtick inline code
- regenerate docs/content/reference/sdk-reference/python/ pages
- add regression tests for raises parsing and reST normalization

Flagged by Greptile on the legacy-repo auto-PR (ComposioHQ/composio#4479).

2026-09-15 13:12:25 +02:00

bump.py

…

create-provider.sh

…

generate-docs.py

docs(py): render Raises sections and normalize reST in generated SDK reference

2026-09-15 13:12:25 +02:00

README.md

feat(docs): add MCP class to SDK reference documentation

2026-01-26 20:16:31 -08:00

README.md

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.py transforms data → MDX files
Output written to docs/content/reference/sdk-reference/python/

Configuration

Expected classes: EXPECTED_CLASSES dict maps class name → Composio property
Modules to search: CLASS_MODULES list
Decorators: DECORATORS_TO_DOCUMENT list

CI

.github/workflows/generate-sdk-docs.yml triggers on changes to python/composio/** and opens a PR with updated docs.