/
mkdocs.yml
283 lines (275 loc) · 10.9 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
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
site_name: Pydantic
site_description: Data validation using Python type hints
strict: true
site_url: https://docs.pydantic.dev/
theme:
name: 'material'
custom_dir: 'docs/theme'
palette:
- 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
name: "Switch to light mode"
features:
- content.tabs.link
- content.code.annotate
- content.code.copy
- announce.dismiss
- navigation.tabs
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.instant.progress
- navigation.path
- navigation.top
- navigation.tracking
- search.suggest
- toc.follow
logo: 'logo-white.svg'
favicon: 'favicon.png'
repo_name: pydantic/pydantic
repo_url: https://github.com/pydantic/pydantic
edit_uri: edit/main/docs/
extra:
version:
provider: mike
analytics:
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!
# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
extra_css:
- 'extra/terminal.css'
- 'extra/tweaks.css'
extra_javascript:
- 'extra/feedback.js'
- 'extra/fluff.js'
- 'https://samuelcolvin.github.io/mkdocs-run-code/run_code_main.js'
nav:
- Get Started:
- Welcome to Pydantic: index.md
- Why use Pydantic: why.md
- Help with Pydantic: help_with_pydantic.md
- Installation: install.md
- Migration Guide: migration.md
- Version Policy: version-policy.md
- Contributing: contributing.md
- Changelog: changelog.md
- Concepts:
- Models: concepts/models.md
- Fields: concepts/fields.md
- JSON Schema: concepts/json_schema.md
- JSON: concepts/json.md
- Types: concepts/types.md
- Unions: concepts/unions.md
- Alias: concepts/alias.md
- Configuration: concepts/config.md
- Serialization: concepts/serialization.md
- Validators: concepts/validators.md
- Dataclasses: concepts/dataclasses.md
- Postponed Annotations: concepts/postponed_annotations.md
- Strict Mode: concepts/strict_mode.md
- Type Adapter: concepts/type_adapter.md
- Validation Decorator: concepts/validation_decorator.md
- Conversion Table: concepts/conversion_table.md
- Settings Management: concepts/pydantic_settings.md
- Performance: concepts/performance.md
- Pydantic Plugins: concepts/plugins.md
- API Documentation:
- Pydantic:
- BaseModel: api/base_model.md
- RootModel: api/root_model.md
- Pydantic Dataclasses: api/dataclasses.md
- TypeAdapter: api/type_adapter.md
- Validate Call: api/validate_call.md
- Fields: api/fields.md
- Aliases: api/aliases.md
- Configuration: api/config.md
- JSON Schema: api/json_schema.md
- Errors: api/errors.md
- Functional Validators: api/functional_validators.md
- Functional Serializers: api/functional_serializers.md
- Standard Library Types: api/standard_library_types.md
- Pydantic Types: api/types.md
- Network Types: api/networks.md
- Version Information: api/version.md
- Pydantic Plugins: api/plugin.md
- Annotated Handlers: api/annotated_handlers.md
- Pydantic Core:
- pydantic_core: api/pydantic_core.md
- pydantic_core.core_schema: api/pydantic_core_schema.md
- Pydantic Settings: api/pydantic_settings.md
- Pydantic Extra Types:
- Color: api/pydantic_extra_types_color.md
- Country: api/pydantic_extra_types_country.md
- Payment: api/pydantic_extra_types_payment.md
- Phone Numbers: api/pydantic_extra_types_phone_numbers.md
- Routing Numbers: api/pydantic_extra_types_routing_numbers.md
- Coordinate: api/pydantic_extra_types_coordinate.md
- Mac Address: api/pydantic_extra_types_mac_address.md
- ISBN: api/pydantic_extra_types_isbn.md
- Pendulum: api/pydantic_extra_types_pendulum_dt.md
- Currency: api/pydantic_extra_types_currency_code.md
- Language: api/pydantic_extra_types_language_code.md
- Examples:
- Secrets: examples/secrets.md
- Validators: examples/validators.md
- Error Messages:
- Error Handling: errors/errors.md
- Validation Errors: errors/validation_errors.md
- Usage Errors: errors/usage_errors.md
- Integrations:
- Mypy: integrations/mypy.md/.
- PyCharm: integrations/pycharm.md
- Hypothesis: integrations/hypothesis.md
- Visual Studio Code: integrations/visual_studio_code.md
- datamodel-code-generator: integrations/datamodel_code_generator.md
- devtools: integrations/devtools.md
- Rich: integrations/rich.md
- Linting: integrations/linting.md
- Blog: https://blog.pydantic.dev/
- Pydantic People: pydantic_people.md
markdown_extensions:
- tables
- toc:
permalink: true
title: Page contents
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.extra
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
watch:
- pydantic
plugins:
- mike:
alias_type: symlink
canonical_version: latest
- search
- exclude:
glob:
- theme/announce.html
- plugins/*
- __pycache__/*
- mkdocstrings:
handlers:
python:
paths: [.]
options:
members_order: source
separate_signature: true
filters: ["!^_(?!defer_build_mode)"]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_signature_annotations: true
signature_crossrefs: true
extensions:
- docs/plugins/griffe_doclinks.py
import:
- https://docs.python.org/3/objects.inv
- mkdocs-simple-hooks:
hooks:
on_pre_build: 'docs.plugins.main:on_pre_build'
on_files: 'docs.plugins.main:on_files'
on_page_markdown: 'docs.plugins.main:on_page_markdown'
- redirects:
redirect_maps:
'usage/mypy.md': 'integrations/mypy.md'
'mypy_plugin.md': 'integrations/mypy.md'
'datamodel_code_generator.md': 'integrations/datamodel_code_generator.md'
'visual_studio_code.md': 'integrations/visual_studio_code.md'
'hypothesis_plugin.md': 'integrations/hypothesis.md'
'pycharm_plugin.md': 'integrations/pycharm.md'
'usage/model_config.md': 'api/config.md'
'usage/devtools.md': 'integrations/devtools.md'
'usage/rich.md': 'integrations/rich.md'
'usage/linting.md': 'integrations/linting.md'
'usage/types.md': 'concepts/types.md'
'usage/types/secrets.md': 'examples/secrets.md'
'usage/types/string_types.md': 'api/types.md#pydantic.types.StringConstraints'
'usage/types/file_types.md': 'api/types.md#pydantic.types.FilePath'
'api/main.md': 'api/base_model.md'
'api/color.md': 'api/pydantic_extra_types_color.md'
'api/alias_generators.md': 'api/config.md#pydantic.config.ConfigDict.alias_generator'
'api/pydantic_core_init.md': 'api/pydantic_core.md'
'usage/types/booleans.md': 'api/standard_library_types.md#booleans'
'usage/types/callables.md': 'api/standard_library_types.md#callable'
'usage/types/custom.md': 'concepts/types.md#custom-types'
'usage/types/datetime.md': 'api/standard_library_types.md#datetime-types'
'usage/types/enum.md': 'api/standard_library_types.md#enum'
'usage/types/json.md': 'api/types.md#pydantic.types.Json'
'usage/types/list_types.md': 'api/standard_library_types.md#list'
'usage/types/standard_types.md': 'api/standard_library_types.md'
'usage/types/strict_types.md': 'concepts/types.md#strict-types'
'usage/types/types.md': 'concepts/types.md'
'usage/types/urls.md': 'api/networks.md'
'usage/types/unions.md': 'api/standard_library_types.md#union'
'usage/types/typevars.md': 'api/standard_library_types.md#type-and-typevar'
'usage/types/types_fields.md': 'api/standard_library_types.md'
'usage/validation_errors.md': 'errors/validation_errors.md'
'usage/errors.md': 'errors/usage_errors.md'
'usage/types/extra_types/color_types.md': 'api/pydantic_extra_types_color.md'
'usage/types/extra_types/extra_types.md': 'api/pydantic_extra_types_color.md'
'usage/types/extra_types/coordinate.md': 'api/pydantic_extra_types_coordinate.md'
'usage/types/extra_types/mac_address.md': 'api/pydantic_extra_types_mac_address.md'
'usage/types/extra_types/payment_cards.md': 'api/pydantic_extra_types_payment.md'
'usage/types/extra_types/phone_numbers.md': 'api/pydantic_extra_types_phone_numbers.md'
'usage/types/extra_types/routing_numbers.md': 'api/pydantic_extra_types_routing_numbers.md'
'version-compatibility.md': 'version-policy.md'
'api/pydantic_extra_types_routing_number.md': 'api/pydantic_extra_types_routing_numbers.md'
'usage/computed_fields.md': 'api/fields.md#pydantic.fields.computed_field'
'usage/conversion_table.md': 'concepts/conversion_table.md'
'usage/dataclasses.md': 'concepts/dataclasses.md'
'usage/fields.md': 'concepts/fields.md'
'usage/json_schema.md': 'concepts/json_schema.md'
'usage/models.md': 'concepts/models.md'
'usage/postponed_annotations.md': 'concepts/postponed_annotations.md'
'usage/pydantic_settings.md': 'concepts/pydantic_settings.md'
'usage/serialization.md': 'concepts/serialization.md'
'usage/strict_mode.md': 'concepts/strict_mode.md'
'usage/type_adapter.md': 'concepts/type_adapter.md'
'usage/validation_decorator.md': 'concepts/validation_decorator.md'
'usage/validators.md': 'concepts/validators.md'
'usage/types/bytesize.md': 'api/types.md#pydantic.types.ByteSize'
'usage/types/dicts_mapping.md': 'api/standard_library_types.md#mapping-types'
'usage/types/encoded.md': 'api/types.md#pydantic.types.EncodedBytes'
'usage/types/enums.md': 'api/standard_library_types.md#enum'
'usage/types/number_types.md': 'api/standard_library_types.md#number-types'
'usage/types/sequence_iterable.md': 'api/standard_library_types.md#other-iterables'
'usage/types/set_types.md': 'api/standard_library_types.md#sets'
'usage/types/uuids.md': 'api/standard_library_types.md#uuid'
'blog/pydantic-v2-alpha.md': 'https://blog.pydantic.dev/blog/2023/04/03/pydantic-v2-pre-release/'
'blog/pydantic-v2-final.md': 'https://blog.pydantic.dev/blog/2023/06/30/pydantic-v2-is-here/'
'blog/pydantic-v2.md': 'https://blog.pydantic.dev/blog/2022/07/10/pydantic-v2-plan/'
- external-markdown: