diff --git a/Makefile b/Makefile index 9a88f93a1..93bc25332 100644 --- a/Makefile +++ b/Makefile @@ -44,6 +44,7 @@ old_version_tests: .PHONY: build-docs build-docs: + uv run docs/scripts/generate_ref_files.py uv run mkdocs build .PHONY: build-full-docs diff --git a/docs/ref/computer.md b/docs/ref/computer.md new file mode 100644 index 000000000..44a3b616f --- /dev/null +++ b/docs/ref/computer.md @@ -0,0 +1,3 @@ +# `Computer` + +::: agents.computer diff --git a/docs/ref/extensions/models/litellm_model.md b/docs/ref/extensions/models/litellm_model.md new file mode 100644 index 000000000..a635daeb3 --- /dev/null +++ b/docs/ref/extensions/models/litellm_model.md @@ -0,0 +1,3 @@ +# `LiteLLM Model` + +::: agents.extensions.models.litellm_model diff --git a/docs/ref/extensions/models/litellm_provider.md b/docs/ref/extensions/models/litellm_provider.md new file mode 100644 index 000000000..0bb5083c5 --- /dev/null +++ b/docs/ref/extensions/models/litellm_provider.md @@ -0,0 +1,3 @@ +# `LiteLLM Provider` + +::: agents.extensions.models.litellm_provider diff --git a/docs/ref/extensions/visualization.md b/docs/ref/extensions/visualization.md new file mode 100644 index 000000000..d38006eb0 --- /dev/null +++ b/docs/ref/extensions/visualization.md @@ -0,0 +1,3 @@ +# `Visualization` + +::: agents.extensions.visualization diff --git a/docs/ref/logger.md b/docs/ref/logger.md new file mode 100644 index 000000000..dffdb2052 --- /dev/null +++ b/docs/ref/logger.md @@ -0,0 +1,3 @@ +# `Logger` + +::: agents.logger diff --git a/docs/ref/models/chatcmpl_converter.md b/docs/ref/models/chatcmpl_converter.md new file mode 100644 index 000000000..536018dbb --- /dev/null +++ b/docs/ref/models/chatcmpl_converter.md @@ -0,0 +1,3 @@ +# `Chatcmpl Converter` + +::: agents.models.chatcmpl_converter diff --git a/docs/ref/models/chatcmpl_helpers.md b/docs/ref/models/chatcmpl_helpers.md new file mode 100644 index 000000000..bf386f640 --- /dev/null +++ b/docs/ref/models/chatcmpl_helpers.md @@ -0,0 +1,3 @@ +# `Chatcmpl Helpers` + +::: agents.models.chatcmpl_helpers diff --git a/docs/ref/models/chatcmpl_stream_handler.md b/docs/ref/models/chatcmpl_stream_handler.md new file mode 100644 index 000000000..44ad50038 --- /dev/null +++ b/docs/ref/models/chatcmpl_stream_handler.md @@ -0,0 +1,3 @@ +# `Chatcmpl Stream Handler` + +::: agents.models.chatcmpl_stream_handler diff --git a/docs/ref/models/fake_id.md b/docs/ref/models/fake_id.md new file mode 100644 index 000000000..887cc8042 --- /dev/null +++ b/docs/ref/models/fake_id.md @@ -0,0 +1,3 @@ +# `Fake Id` + +::: agents.models.fake_id diff --git a/docs/ref/models/multi_provider.md b/docs/ref/models/multi_provider.md new file mode 100644 index 000000000..dc07cfba7 --- /dev/null +++ b/docs/ref/models/multi_provider.md @@ -0,0 +1,3 @@ +# `Multi Provider` + +::: agents.models.multi_provider diff --git a/docs/ref/models/openai_provider.md b/docs/ref/models/openai_provider.md new file mode 100644 index 000000000..ae713138c --- /dev/null +++ b/docs/ref/models/openai_provider.md @@ -0,0 +1,3 @@ +# `OpenAI Provider` + +::: agents.models.openai_provider diff --git a/docs/ref/prompts.md b/docs/ref/prompts.md new file mode 100644 index 000000000..80e0fb4e8 --- /dev/null +++ b/docs/ref/prompts.md @@ -0,0 +1,3 @@ +# `Prompts` + +::: agents.prompts diff --git a/docs/ref/strict_schema.md b/docs/ref/strict_schema.md new file mode 100644 index 000000000..0ac0d964f --- /dev/null +++ b/docs/ref/strict_schema.md @@ -0,0 +1,3 @@ +# `Strict Schema` + +::: agents.strict_schema diff --git a/docs/ref/tool_context.md b/docs/ref/tool_context.md new file mode 100644 index 000000000..ea7b51a64 --- /dev/null +++ b/docs/ref/tool_context.md @@ -0,0 +1,3 @@ +# `Tool Context` + +::: agents.tool_context diff --git a/docs/ref/tracing/logger.md b/docs/ref/tracing/logger.md new file mode 100644 index 000000000..0fb0c6245 --- /dev/null +++ b/docs/ref/tracing/logger.md @@ -0,0 +1,3 @@ +# `Logger` + +::: agents.tracing.logger diff --git a/docs/ref/tracing/provider.md b/docs/ref/tracing/provider.md new file mode 100644 index 000000000..f4c83b4e9 --- /dev/null +++ b/docs/ref/tracing/provider.md @@ -0,0 +1,3 @@ +# `Provider` + +::: agents.tracing.provider diff --git a/docs/ref/version.md b/docs/ref/version.md new file mode 100644 index 000000000..f2aeac9ea --- /dev/null +++ b/docs/ref/version.md @@ -0,0 +1,3 @@ +# `Version` + +::: agents.version diff --git a/docs/ref/voice/imports.md b/docs/ref/voice/imports.md new file mode 100644 index 000000000..dc781cc5b --- /dev/null +++ b/docs/ref/voice/imports.md @@ -0,0 +1,3 @@ +# `Imports` + +::: agents.voice.imports diff --git a/docs/ref/voice/models/openai_model_provider.md b/docs/ref/voice/models/openai_model_provider.md new file mode 100644 index 000000000..20ef17dd6 --- /dev/null +++ b/docs/ref/voice/models/openai_model_provider.md @@ -0,0 +1,3 @@ +# `OpenAI Model Provider` + +::: agents.voice.models.openai_model_provider diff --git a/docs/scripts/generate_ref_files.py b/docs/scripts/generate_ref_files.py new file mode 100644 index 000000000..9deef7528 --- /dev/null +++ b/docs/scripts/generate_ref_files.py @@ -0,0 +1,76 @@ +#!/usr/bin/env python +""" +generate_ref_files.py + +Create missing Markdown reference stubs for mkdocstrings. + +Usage: + python scripts/generate_ref_files.py +""" + +from pathlib import Path +from string import capwords + +# ---- Paths ----------------------------------------------------------- + +REPO_ROOT = Path(__file__).resolve().parent.parent.parent # adjust if layout differs +SRC_ROOT = REPO_ROOT / "src" / "agents" # source tree to scan +DOCS_ROOT = REPO_ROOT / "docs" / "ref" # where stubs go + +# ---- Helpers --------------------------------------------------------- + + +def to_identifier(py_path: Path) -> str: + """Convert src/agents/foo/bar.py -> 'agents.foo.bar'.""" + rel = py_path.relative_to(SRC_ROOT).with_suffix("") # drop '.py' + return ".".join(("agents", *rel.parts)) + + +def md_target(py_path: Path) -> Path: + """Return docs/ref/.../*.md path corresponding to py_path.""" + rel = py_path.relative_to(SRC_ROOT).with_suffix(".md") + return DOCS_ROOT / rel + +def pretty_title(last_segment: str) -> str: + """ + Convert a module/file segment like 'tool_context' to 'Tool Context'. + Handles underscores and hyphens; leaves camelCase as‑is except first‑letter cap. + """ + cleaned = last_segment.replace("_", " ").replace("-", " ") + return capwords(cleaned) + +# ---- Main ------------------------------------------------------------ + + +def main() -> None: + if not SRC_ROOT.exists(): + raise SystemExit(f"Source path not found: {SRC_ROOT}") + + created = 0 + for py_file in SRC_ROOT.rglob("*.py"): + if py_file.name.startswith("_"): # skip private files + continue + md_path = md_target(py_file) + if md_path.exists(): + continue # keep existing + md_path.parent.mkdir(parents=True, exist_ok=True) + + identifier = to_identifier(py_file) + title = pretty_title(identifier.split(".")[-1]) # last segment + + md_content = f"""# `{title}` + +::: {identifier} +""" + md_path.write_text(md_content, encoding="utf-8") + created += 1 + print(f"Created {md_path.relative_to(REPO_ROOT)}") + + if created == 0: + print("All reference files were already present.") + else: + print(f"Done. {created} new file(s) created.") + + +if __name__ == "__main__": + main() diff --git a/mkdocs.yml b/mkdocs.yml index a465bfefa..0ac288bfc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,6 +86,7 @@ plugins: - ref/memory.md - ref/repl.md - ref/tool.md + - ref/tool_context.md - ref/result.md - ref/stream_events.md - ref/handoffs.md