|
1 | 1 | site_name: OpenAI Agents SDK |
2 | 2 | theme: |
3 | | - name: material |
4 | | - features: |
5 | | - # Allows copying code blocks |
6 | | - - content.code.copy |
7 | | - # Allows selecting code blocks |
8 | | - - content.code.select |
9 | | - # Shows the current path in the sidebar |
10 | | - - navigation.path |
11 | | - # Shows sections in the sidebar |
12 | | - - navigation.sections |
13 | | - # Shows sections expanded by default |
14 | | - - navigation.expand |
15 | | - # Enables annotations in code blocks |
16 | | - - content.code.annotate |
17 | | - palette: |
18 | | - primary: black |
19 | | - logo: assets/logo.svg |
20 | | - favicon: images/favicon-platform.svg |
| 3 | + name: material |
| 4 | + features: |
| 5 | + # Allows copying code blocks |
| 6 | + - content.code.copy |
| 7 | + # Allows selecting code blocks |
| 8 | + - content.code.select |
| 9 | + # Shows the current path in the sidebar |
| 10 | + - navigation.path |
| 11 | + # Shows sections in the sidebar |
| 12 | + - navigation.sections |
| 13 | + # Shows sections expanded by default |
| 14 | + - navigation.expand |
| 15 | + # Enables annotations in code blocks |
| 16 | + - content.code.annotate |
| 17 | + palette: |
| 18 | + primary: black |
| 19 | + logo: assets/logo.svg |
| 20 | + favicon: images/favicon-platform.svg |
21 | 21 | nav: |
22 | | - - Intro: index.md |
23 | | - - Quickstart: quickstart.md |
24 | | - - Examples: examples.md |
25 | | - - Documentation: |
26 | | - - agents.md |
27 | | - - running_agents.md |
28 | | - - results.md |
29 | | - - streaming.md |
30 | | - - tools.md |
31 | | - - handoffs.md |
32 | | - - tracing.md |
33 | | - - context.md |
34 | | - - guardrails.md |
35 | | - - multi_agent.md |
36 | | - - models.md |
37 | | - - config.md |
38 | | - - API Reference: |
39 | | - - Agents: |
40 | | - - ref/index.md |
41 | | - - ref/agent.md |
42 | | - - ref/run.md |
43 | | - - ref/tool.md |
44 | | - - ref/result.md |
45 | | - - ref/stream_events.md |
46 | | - - ref/handoffs.md |
47 | | - - ref/lifecycle.md |
48 | | - - ref/items.md |
49 | | - - ref/run_context.md |
50 | | - - ref/usage.md |
51 | | - - ref/exceptions.md |
52 | | - - ref/guardrail.md |
53 | | - - ref/model_settings.md |
54 | | - - ref/agent_output.md |
55 | | - - ref/function_schema.md |
56 | | - - ref/models/interface.md |
57 | | - - ref/models/openai_chatcompletions.md |
58 | | - - ref/models/openai_responses.md |
59 | | - - Tracing: |
60 | | - - ref/tracing/index.md |
61 | | - - ref/tracing/create.md |
62 | | - - ref/tracing/traces.md |
63 | | - - ref/tracing/spans.md |
64 | | - - ref/tracing/processor_interface.md |
65 | | - - ref/tracing/processors.md |
66 | | - - ref/tracing/scope.md |
67 | | - - ref/tracing/setup.md |
68 | | - - ref/tracing/span_data.md |
69 | | - - ref/tracing/util.md |
70 | | - - Extensions: |
71 | | - - ref/extensions/handoff_filters.md |
72 | | - - ref/extensions/handoff_prompt.md |
| 22 | + - Intro: index.md |
| 23 | + - Quickstart: quickstart.md |
| 24 | + - Examples: examples.md |
| 25 | + - Documentation: |
| 26 | + - agents.md |
| 27 | + - running_agents.md |
| 28 | + - results.md |
| 29 | + - streaming.md |
| 30 | + - tools.md |
| 31 | + - handoffs.md |
| 32 | + - tracing.md |
| 33 | + - context.md |
| 34 | + - guardrails.md |
| 35 | + - multi_agent.md |
| 36 | + - models.md |
| 37 | + - config.md |
| 38 | + - API Reference: |
| 39 | + - Agents: |
| 40 | + - ref/index.md |
| 41 | + - ref/agent.md |
| 42 | + - ref/run.md |
| 43 | + - ref/tool.md |
| 44 | + - ref/result.md |
| 45 | + - ref/stream_events.md |
| 46 | + - ref/handoffs.md |
| 47 | + - ref/lifecycle.md |
| 48 | + - ref/items.md |
| 49 | + - ref/run_context.md |
| 50 | + - ref/usage.md |
| 51 | + - ref/exceptions.md |
| 52 | + - ref/guardrail.md |
| 53 | + - ref/model_settings.md |
| 54 | + - ref/agent_output.md |
| 55 | + - ref/function_schema.md |
| 56 | + - ref/models/interface.md |
| 57 | + - ref/models/openai_chatcompletions.md |
| 58 | + - ref/models/openai_responses.md |
| 59 | + - Tracing: |
| 60 | + - ref/tracing/index.md |
| 61 | + - ref/tracing/create.md |
| 62 | + - ref/tracing/traces.md |
| 63 | + - ref/tracing/spans.md |
| 64 | + - ref/tracing/processor_interface.md |
| 65 | + - ref/tracing/processors.md |
| 66 | + - ref/tracing/scope.md |
| 67 | + - ref/tracing/setup.md |
| 68 | + - ref/tracing/span_data.md |
| 69 | + - ref/tracing/util.md |
| 70 | + - Extensions: |
| 71 | + - ref/extensions/handoff_filters.md |
| 72 | + - ref/extensions/handoff_prompt.md |
73 | 73 |
|
74 | 74 | plugins: |
75 | | - - search |
76 | | - - mkdocstrings: |
77 | | - handlers: |
78 | | - python: |
79 | | - paths: ["src/agents"] |
80 | | - selection: |
81 | | - docstring_style: google |
82 | | - options: |
83 | | - # Shows links to other members in signatures |
84 | | - signature_crossrefs: true |
85 | | - # Orders members by source order, rather than alphabetical |
86 | | - members_order: source |
87 | | - # Puts the signature on a separate line from the member name |
88 | | - separate_signature: true |
89 | | - # Shows type annotations in signatures |
90 | | - show_signature_annotations: true |
91 | | - # Makes the font sizes nicer |
92 | | - heading_level: 3 |
| 75 | + - search |
| 76 | + - mkdocstrings: |
| 77 | + handlers: |
| 78 | + python: |
| 79 | + paths: ["src/agents"] |
| 80 | + selection: |
| 81 | + docstring_style: google |
| 82 | + options: |
| 83 | + # Shows links to other members in signatures |
| 84 | + signature_crossrefs: true |
| 85 | + # Orders members by source order, rather than alphabetical |
| 86 | + members_order: source |
| 87 | + # Puts the signature on a separate line from the member name |
| 88 | + separate_signature: true |
| 89 | + # Shows type annotations in signatures |
| 90 | + show_signature_annotations: true |
| 91 | + # Makes the font sizes nicer |
| 92 | + heading_level: 3 |
93 | 93 |
|
94 | 94 | extra: |
95 | | - # Remove material generation message in footer |
96 | | - generator: false |
| 95 | + # Remove material generation message in footer |
| 96 | + generator: false |
97 | 97 |
|
98 | 98 | markdown_extensions: |
99 | | - - admonition |
100 | | - - pymdownx.details |
101 | | - - pymdownx.superfences |
102 | | - - attr_list |
103 | | - - md_in_html |
104 | | - - pymdownx.highlight: |
105 | | - anchor_linenums: true |
106 | | - line_spans: __span |
107 | | - pygments_lang_class: true |
108 | | - - pymdownx.inlinehilite |
109 | | - - pymdownx.snippets |
110 | | - - pymdownx.superfences |
| 99 | + - admonition |
| 100 | + - pymdownx.details |
| 101 | + - pymdownx.superfences |
| 102 | + - attr_list |
| 103 | + - md_in_html |
| 104 | + - pymdownx.highlight: |
| 105 | + anchor_linenums: true |
| 106 | + line_spans: __span |
| 107 | + pygments_lang_class: true |
| 108 | + - pymdownx.inlinehilite |
| 109 | + - pymdownx.snippets |
| 110 | + - pymdownx.superfences |
111 | 111 |
|
112 | 112 | validation: |
113 | | - omitted_files: warn |
114 | | - absolute_links: warn |
115 | | - unrecognized_links: warn |
116 | | - anchors: warn |
| 113 | + omitted_files: warn |
| 114 | + absolute_links: warn |
| 115 | + unrecognized_links: warn |
| 116 | + anchors: warn |
117 | 117 |
|
118 | 118 | extra_css: |
119 | | - - stylesheets/extra.css |
| 119 | + - stylesheets/extra.css |
120 | 120 |
|
121 | 121 | watch: |
122 | | - - "src/agents" |
| 122 | + - "src/agents" |
0 commit comments