admin-valentin/openai-agents-python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Indentation for mkdocs.yml (#264)

Browse source
This commit is contained in:
Rohan Mehta 2025-03-20 11:21:27 -04:00 committed by GitHub
commit 1e02b9894d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 107 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

214
mkdocs.yml
View file

@ -1,122 +1,122 @@
site_name: OpenAI Agents SDK site_name: OpenAI Agents SDK
theme: theme:
name: material name: material
features: features:
# Allows copying code blocks # Allows copying code blocks
- content.code.copy - content.code.copy
# Allows selecting code blocks # Allows selecting code blocks
- content.code.select - content.code.select
# Shows the current path in the sidebar # Shows the current path in the sidebar
- navigation.path - navigation.path
# Shows sections in the sidebar # Shows sections in the sidebar
- navigation.sections - navigation.sections
# Shows sections expanded by default # Shows sections expanded by default
- navigation.expand - navigation.expand
# Enables annotations in code blocks # Enables annotations in code blocks
- content.code.annotate - content.code.annotate
palette: palette:
primary: black primary: black
logo: assets/logo.svg logo: assets/logo.svg
favicon: images/favicon-platform.svg favicon: images/favicon-platform.svg
nav: nav:
- Intro: index.md - Intro: index.md
- Quickstart: quickstart.md - Quickstart: quickstart.md
- Examples: examples.md - Examples: examples.md
- Documentation: - Documentation:
- agents.md - agents.md
- running_agents.md - running_agents.md
- results.md - results.md
- streaming.md - streaming.md
- tools.md - tools.md
- handoffs.md - handoffs.md
- tracing.md - tracing.md
- context.md - context.md
- guardrails.md - guardrails.md
- multi_agent.md - multi_agent.md
- models.md - models.md
- config.md - config.md
- API Reference: - API Reference:
- Agents: - Agents:
- ref/index.md - ref/index.md
- ref/agent.md - ref/agent.md
- ref/run.md - ref/run.md
- ref/tool.md - ref/tool.md
- ref/result.md - ref/result.md
- ref/stream_events.md - ref/stream_events.md
- ref/handoffs.md - ref/handoffs.md
- ref/lifecycle.md - ref/lifecycle.md
- ref/items.md - ref/items.md
- ref/run_context.md - ref/run_context.md
- ref/usage.md - ref/usage.md
- ref/exceptions.md - ref/exceptions.md
- ref/guardrail.md - ref/guardrail.md
- ref/model_settings.md - ref/model_settings.md
- ref/agent_output.md - ref/agent_output.md
- ref/function_schema.md - ref/function_schema.md
- ref/models/interface.md - ref/models/interface.md
- ref/models/openai_chatcompletions.md - ref/models/openai_chatcompletions.md
- ref/models/openai_responses.md - ref/models/openai_responses.md
- Tracing: - Tracing:
- ref/tracing/index.md - ref/tracing/index.md
- ref/tracing/create.md - ref/tracing/create.md
- ref/tracing/traces.md - ref/tracing/traces.md
- ref/tracing/spans.md - ref/tracing/spans.md
- ref/tracing/processor_interface.md - ref/tracing/processor_interface.md
- ref/tracing/processors.md - ref/tracing/processors.md
- ref/tracing/scope.md - ref/tracing/scope.md
- ref/tracing/setup.md - ref/tracing/setup.md
- ref/tracing/span_data.md - ref/tracing/span_data.md
- ref/tracing/util.md - ref/tracing/util.md
- Extensions: - Extensions:
- ref/extensions/handoff_filters.md - ref/extensions/handoff_filters.md
- ref/extensions/handoff_prompt.md - ref/extensions/handoff_prompt.md
plugins: plugins:
- search - search
- mkdocstrings: - mkdocstrings:
handlers: handlers:
python: python:
paths: ["src/agents"] paths: ["src/agents"]
selection: selection:
docstring_style: google docstring_style: google
options: options:
# Shows links to other members in signatures # Shows links to other members in signatures
signature_crossrefs: true signature_crossrefs: true
# Orders members by source order, rather than alphabetical # Orders members by source order, rather than alphabetical
members_order: source members_order: source
# Puts the signature on a separate line from the member name # Puts the signature on a separate line from the member name
separate_signature: true separate_signature: true
# Shows type annotations in signatures # Shows type annotations in signatures
show_signature_annotations: true show_signature_annotations: true
# Makes the font sizes nicer # Makes the font sizes nicer
heading_level: 3 heading_level: 3
extra: extra:
# Remove material generation message in footer # Remove material generation message in footer
generator: false generator: false
markdown_extensions: markdown_extensions:
- admonition - admonition
- pymdownx.details - pymdownx.details
- pymdownx.superfences - pymdownx.superfences
- attr_list - attr_list
- md_in_html - md_in_html
- pymdownx.highlight: - pymdownx.highlight:
anchor_linenums: true anchor_linenums: true
line_spans: __span line_spans: __span
pygments_lang_class: true pygments_lang_class: true
- pymdownx.inlinehilite - pymdownx.inlinehilite
- pymdownx.snippets - pymdownx.snippets
- pymdownx.superfences - pymdownx.superfences
validation: validation:
omitted_files: warn omitted_files: warn
absolute_links: warn absolute_links: warn
unrecognized_links: warn unrecognized_links: warn
anchors: warn anchors: warn
extra_css: extra_css:
- stylesheets/extra.css - stylesheets/extra.css
watch: watch:
- "src/agents" - "src/agents"