-
Notifications
You must be signed in to change notification settings - Fork 116
/
mkdocs.yml
166 lines (155 loc) · 4.29 KB
/
mkdocs.yml
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
site_name: PydanticAI
site_description: Agent Framework / shim to use Pydantic with LLMs
strict: true
site_url: https://ai.pydantic.dev
repo_name: pydantic/pydantic-ai
repo_url: https://github.com/pydantic/pydantic-ai
edit_uri: edit/main/docs/
copyright: © Pydantic Services Inc. 2024 to present
nav:
- Introduction: index.md
- install.md
- help.md
- Documentation:
- agents.md
- dependencies.md
- results.md
- message-history.md
- testing-evals.md
- logfire.md
- Examples:
- examples/index.md
- examples/pydantic-model.md
- examples/weather-agent.md
- examples/bank-support.md
- examples/sql-gen.md
- examples/rag.md
- examples/stream-markdown.md
- examples/stream-whales.md
- examples/chat-app.md
- API Reference:
- api/agent.md
- api/tools.md
- api/result.md
- api/messages.md
- api/exceptions.md
- api/models/base.md
- api/models/openai.md
- api/models/gemini.md
- api/models/vertexai.md
- api/models/groq.md
- api/models/test.md
- api/models/function.md
extra:
# hide the "Made with Material for MkDocs" message
generator: false
theme:
name: "material"
palette:
- media: "(prefers-color-scheme)"
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: "Switch to light mode"
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
accent: pink
toggle:
icon: material/lightbulb-auto-outline
name: "Switch to system preference"
features:
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotate
- content.code.copy
- content.code.select
- navigation.path
# - navigation.expand
- navigation.indexes
- navigation.sections
- navigation.tracking
- toc.follow
# - navigation.tabs # don't use navbar tabs
logo: "img/logo-white.svg"
favicon: "favicon.ico"
# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
extra_css:
- 'extra/tweaks.css'
# used for analytics
extra_javascript:
- "/flarelytics/client.js"
markdown_extensions:
- tables
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.caret
- pymdownx.critic
- pymdownx.mark
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tilde
- pymdownx.inlinehilite
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.extra:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- sane_lists # this means you can start a list from any number
watch:
- pydantic_ai_slim
- pydantic_ai_examples
plugins:
- search
- social
- glightbox
- mkdocstrings:
handlers:
python:
paths: [src/packages/pydantic_ai_slim/pydantic_ai]
options:
relative_crossrefs: true
members_order: source
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
group_by_category: false
# 3 because docs are in pages with an H2 just above them
heading_level: 3
import:
- url: https://docs.python.org/3/objects.inv
- url: https://docs.pydantic.dev/latest/objects.inv
- url: https://dirty-equals.helpmanual.io/latest/objects.inv
- url: https://fastapi.tiangolo.com/objects.inv
- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
- url: https://rich.readthedocs.io/en/stable/objects.inv
# waiting for https://github.com/encode/httpx/discussions/3091#discussioncomment-11205594
hooks:
- 'docs/.hooks/main.py'