* docs: organize SDK guides and clarify examples * fix: correct native SDK type declarations * test: update native SDK contract fixtures * fix: normalize persisted agent profile transport settings * test: reconcile inherited model settings API snapshot * test: preserve executor coverage on Windows --------- Co-authored-by: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com>
61 lines
1.8 KiB
YAML
61 lines
1.8 KiB
YAML
site_name: OpenAI Agents SDK
|
|
site_description: Build Python agents with the native Codex harness.
|
|
docs_dir: docs/sdk
|
|
repo_name: openai/openai-agents-python
|
|
repo_url: https://github.com/openai/openai-agents-python
|
|
edit_uri: edit/feat/codex-harness/docs/sdk/
|
|
theme:
|
|
name: material
|
|
palette:
|
|
primary: black
|
|
features:
|
|
- content.code.copy
|
|
- navigation.sections
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: [src]
|
|
options:
|
|
docstring_style: google
|
|
members_order: source
|
|
separate_signature: true
|
|
show_signature_annotations: true
|
|
heading_level: 3
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.highlight
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
nav:
|
|
- Get started:
|
|
- Quickstart: index.md
|
|
- Installation: installation.md
|
|
- Core concepts: concepts.md
|
|
- Choose how to run your agent: choosing.md
|
|
- Releases and documentation: versions.md
|
|
- Build an agent:
|
|
- Models and authentication: models.md
|
|
- Tools: tools.md
|
|
- MCP servers: mcp.md
|
|
- Structured output: outputs.md
|
|
- Conversations: sessions.md
|
|
- Streaming and events: streaming.md
|
|
- Save and restore state: state.md
|
|
- Configure agent behavior: configuration.md
|
|
- Task recipes: recipes.md
|
|
- Control work:
|
|
- Guardrails: guardrails.md
|
|
- Command execution: execution.md
|
|
- Approvals and manual results: approvals.md
|
|
- Delegate work: delegation.md
|
|
- Test and operate:
|
|
- Testing: testing.md
|
|
- Check custom endpoints: providers.md
|
|
- Usage and tracing: observability.md
|
|
- Troubleshooting: troubleshooting.md
|
|
- API reference: reference.md
|