-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
135 lines (125 loc) · 3.32 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: "Combadge"
site_description: "Generic API client based on Pydantic"
nav:
- index.md
- Support:
- Models:
- support/models/index.md
- support/models/errors.md
- Application protocols:
- support/http.md
- support/soap.md
- Backends:
- support/backends/index.md
- support/backends/httpx.md
- support/backends/zeep.md
- Core:
- core/service-protocol.md
- core/binding.md
- Markers:
- core/markers/index.md
- core/markers/method.md
- core/markers/parameter.md
- core/markers/response.md
- core/service-container.md
- core/exceptions.md
- Cookbook:
- cookbook/capturing-http-status-code.md
- cookbook/do-not-repeat-response-annotations.md
- cookbook/fields-for-simple-requests.md
- cookbook/parameter-validation.md
- tags.md
theme:
icon:
repo: "fontawesome/brands/github"
logo: "material/radio-handheld"
name: material
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.sections
- navigation.top
- navigation.tracking
- search.suggest
- search.highlight
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: System theme
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Dark mode
primary: green
accent: green
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Light mode
primary: green
accent: green
plugins:
- autorefs
- git-revision-date-localized:
enable_creation_date: false
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
line_length: 80
members_order: "source"
merge_init_into_class: false
separate_signature: true
show_bases: false
show_root_toc_entry: false
show_signature_annotations: true
show_source: true
- search:
lang: en
- social
- tags:
tags_file: tags.md
- git-committers:
repository: kpn/combadge
branch: main
markdown_extensions:
- admonition
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
repo_url: https://github.com/kpn/combadge
edit_uri: edit/main/docs/
extra:
social:
- icon: material/github
link: https://github.com/kpn
name: KPN on GitHub
- icon: material/office-building
link: https://jobs.kpn.com/
name: Working at KPN
copyright: Copyright © 2023 Koninklijke KPN N.V.
site_url: "https://kpn.github.io/combadge"
watch:
- "combadge"