FilesExpand file tree

main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

199 lines (191 loc) · 6.08 KB

main

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

199 lines (191 loc) · 6.08 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

site_name: OpenAI Agents SDK

theme:

name: material

features:

# Allows copying code blocks

- content.code.copy

# Allows selecting code blocks

- content.code.select

# Shows the current path in the sidebar

- navigation.path

# Shows sections in the sidebar

- navigation.sections

# Shows sections expanded by default

- navigation.expand

# Enables annotations in code blocks

- content.code.annotate

palette:

primary: black

logo: assets/logo.svg

favicon: images/favicon-platform.svg

repo_name: openai-agents-python

repo_url: https://github.com/openai/openai-agents-python

plugins:

- search

- mkdocstrings:

handlers:

python:

paths: ["src/agents"]

selection:

docstring_style: google

options:

# Shows links to other members in signatures

signature_crossrefs: true

# Orders members by source order, rather than alphabetical

members_order: source

# Puts the signature on a separate line from the member name

separate_signature: true

# Shows type annotations in signatures

show_signature_annotations: true

# Makes the font sizes nicer

heading_level: 3

# Show inherited members

inherited_members: true

- i18n:

docs_structure: folder

languages:

- locale: en

default: true

name: English

build: true

nav:

- Intro: index.md

- Quickstart: quickstart.md

- Examples: examples.md

- Documentation:

- agents.md

- running_agents.md

- results.md

- streaming.md

- tools.md

- mcp.md

- handoffs.md

- tracing.md

- context.md

- guardrails.md

- multi_agent.md

- Models:

- models/index.md

- models/litellm.md

- config.md

- visualization.md

- Voice agents:

- voice/quickstart.md

- voice/pipeline.md

- voice/tracing.md

- API Reference:

- Agents:

- ref/index.md

- ref/agent.md

- ref/run.md

- ref/tool.md

- ref/result.md

- ref/stream_events.md

- ref/handoffs.md

- ref/lifecycle.md

- ref/items.md

- ref/run_context.md

- ref/usage.md

- ref/exceptions.md

- ref/guardrail.md

- ref/model_settings.md

- ref/agent_output.md

- ref/function_schema.md

- ref/models/interface.md

- ref/models/openai_chatcompletions.md

- ref/models/openai_responses.md

- ref/mcp/server.md

- ref/mcp/util.md

- Tracing:

- ref/tracing/index.md

- ref/tracing/create.md

- ref/tracing/traces.md

- ref/tracing/spans.md

- ref/tracing/processor_interface.md

- ref/tracing/processors.md

- ref/tracing/scope.md

- ref/tracing/setup.md

- ref/tracing/span_data.md

- ref/tracing/util.md

- Voice:

- ref/voice/pipeline.md

- ref/voice/workflow.md

- ref/voice/input.md

- ref/voice/result.md

- ref/voice/pipeline_config.md

- ref/voice/events.md

- ref/voice/exceptions.md

- ref/voice/model.md

- ref/voice/utils.md

- ref/voice/models/openai_provider.md

- ref/voice/models/openai_stt.md

- ref/voice/models/openai_tts.md

- Extensions:

- ref/extensions/handoff_filters.md

- ref/extensions/handoff_prompt.md

- ref/extensions/litellm.md

- locale: ja

name: 日本語

build: true

nav:

- はじめに: index.md

- クイックスタート: quickstart.md

- コード例: examples.md

- ドキュメント:

- agents.md

- running_agents.md

- results.md

- streaming.md

- tools.md

- mcp.md

- handoffs.md

- tracing.md

- context.md

- guardrails.md

- multi_agent.md

- モデル:

- models/index.md

- models/litellm.md

- config.md

- visualization.md

- 音声エージェント:

- voice/quickstart.md

- voice/pipeline.md

- voice/tracing.md

extra:

# Remove material generation message in footer

generator: false

language: en

alternate:

- name: English

link: /openai-agents-python/

lang: en

- name: 日本語

link: /openai-agents-python/ja/

lang: ja

markdown_extensions:

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- admonition

- pymdownx.details

- attr_list

- md_in_html

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- pymdownx.superfences

validation:

omitted_files: warn

absolute_links: warn

unrecognized_links: warn

anchors: warn

extra_css:

- stylesheets/extra.css

watch:

- "src/agents"