forked from pydantic/pydantic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
196 lines (189 loc) · 6.25 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
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
- announce.dismiss
- navigation.tabs
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
extra_css:
- 'extra/terminal.css'
- 'extra/tweaks.css'
extra_javascript:
- 'extra/redirects.js'
nav:
- Get Started:
- Welcome to Pydantic: index.md
- Installation: install.md
- Migration Guide: migration.md
- changelog.md
- Usage:
- usage/models.md
- Field Types:
- Types Overview: usage/types/types.md
- Standard Library Types: usage/types/standard_types.md
- Booleans: usage/types/booleans.md
- ByteSize: usage/types/bytesize.md
- Callables: usage/types/callables.md
- Datetimes: usage/types/datetime.md
- Dicts and Mapping: usage/types/dicts_mapping.md
- Encoded Types: usage/types/encoded.md
- Enums and Choices: usage/types/enums.md
- File Types: usage/types/file_types.md
- JSON: usage/types/json.md
- Lists and Tuples: usage/types/list_types.md
- Number Types: usage/types/number_types.md
- Secret Types: usage/types/secrets.md
- Sequence, Iterable, & Iterator: usage/types/sequence_iterable.md
- Sets and frozenset: usage/types/set_types.md
- String Types: usage/types/string_types.md
- Type and TypeVar: usage/types/typevars.md
- Types with Fields: usage/types/types_fields.md
- Unions: usage/types/unions.md
- URLs: usage/types/urls.md
- UUIDs: usage/types/uuids.md
- Encoded: usage/types/encoded.md
- Custom Data Types: usage/types/custom.md
- Extra Types:
- Extra Types Overview: usage/types/extra_types/extra_types.md
- Color Types: usage/types/extra_types/color_types.md
- Payment Card Numbers: usage/types/extra_types/payment_cards.md
- Phone Numbers: usage/types/extra_types/phone_numbers.md
- Routing Numbers: usage/types/extra_types/routing_numbers.md
- usage/validators.md
- 'Model Config': usage/model_config.md
- usage/fields.md
- 'JSON Schema': usage/json_schema.md
- usage/exporting_models.md
- usage/computed_fields.md
- usage/dataclasses.md
- usage/validation_decorator.md
- usage/postponed_annotations.md
- usage/conversion_table.md
- usage/pydantic_settings.md
- Error Messages:
- Error Handling: errors/errors.md
- Validation Errors: usage/validation_errors.md
- Usage 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
- Contribute: contributing.md
- Blog:
- blog/pydantic-v2-alpha.md
- blog/pydantic-v2.md
- API Documentation:
- Pydantic:
- 'pydantic': api/main.md
- 'pydantic.alias_generators': api/alias_generators.md
- 'pydantic.color': api/color.md
- 'pydantic.config': api/config.md
- 'pydantic.dataclasses': api/dataclasses.md
- 'pydantic.errors': api/errors.md
- 'pydantic.fields': api/fields.md
- 'pydantic.functional_serializers': api/functional_serializers.md
- 'pydantic.functional_validators': api/functional_validators.md
- 'pydantic.json_schema': api/json_schema.md
- 'pydantic.mypy': api/mypy.md
- 'pydantic.networks': api/networks.md
- 'pydantic.root_model': api/root_model.md
- 'pydantic.type_adapter': api/type_adapter.md
- 'pydantic.types': api/types.md
- 'pydantic.validate_call': api/validate_call.md
- 'pydantic.version': api/version.md
- Pydantic Core:
- 'pydantic_core': api/pydantic_core_init.md
- 'pydantic_core.core_schema': api/pydantic_core_schema.md
- Pydantic Settings:
- 'pydantic_settings': api/pydantic_settings.md
- Pydantic Extra Types:
- 'pydantic_extra_types.color': api/pydantic_extra_types_color.md
- 'pydantic_extra_types.country': api/pydantic_extra_types_country.md
- 'pydantic_extra_types.payment': api/pydantic_extra_types_payment.md
- 'pydantic_extra_types.phone_numbers': api/pydantic_extra_types_phone_numbers.md
- 'pydantic_extra_types.routing_number': api/pydantic_extra_types_routing_number.md
markdown_extensions:
- tables
- toc:
permalink: true
title: Page contents
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight
- pymdownx.extra
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.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:
separate_signature: true
filters: ["!^_"]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
- 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/devtools.md': 'integrations/devtools.md'
'usage/rich.md': 'integrations/rich.md'
- external-markdown: