-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
130 lines (120 loc) · 3.19 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
# SPDX-FileCopyrightText: 2023 Gert van Dijk <[email protected]>
#
# SPDX-License-Identifier: CC0-1.0
site_name: PyKMP
repo_url: https://github.com/gertvdijk/PyKMP
repo_name: gertvdijk/PyKMP
nav:
- Home: index.md
- getting-started.md
- hardware-requirements.md
- battery-consumption.md
- ser2net.md
- troubleshooting.md
- thanks.md
- Use cases:
- store-graph-metrics.md
- Development:
- API reference:
- api/index.md
- Client: api/client.md
- Messages: api/messages.md
- Codec: api/codec.md
- Constants: api/constants.md
- contributing.md
- resources.md
theme:
name: material
icon:
logo: material/meter-electric
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: deep purple
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: brown
accent: deep orange
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.code.annotate
- navigation.expand
- navigation.footer
- navigation.sections
- navigation.tracking
copyright: Copyright © 2023 Gert van Dijk
extra:
social:
- icon: fontawesome/brands/mastodon
link: https://mastodon.social/@gertvdijk
name: Gert van Dijk on Mastodon
- icon: fontawesome/solid/square
link: https://bsky.app/profile/i6t.nl
name: Gert van Dijk on Bluesky
- icon: fontawesome/brands/github
link: https://github.com/gertvdijk/
name: Gert van Dijk on GitHub
- icon: simple/pypi # fontawesome/brands/python
link: https://pypi.org/project/PyKMP/
name: PyKMP on PyPI.org
markdown_extensions:
- abbr
- admonition
- attr_list
- footnotes
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.keys
- pymdownx.mark
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
# Together with mkdocstrings 'heading_level: 3' hide deeper objects from ToC.
toc_depth: 3
plugins:
- mkdocstrings:
handlers:
python:
paths: ["src/"]
options:
group_by_category: true
heading_level: 3
inherited_members: true
line_length: 88
members_order: source
show_if_no_docstring: true
show_root_heading: true
show_signature_annotations: true
show_source: false
# Insiders only at the time of writing (mkdocstrings/python 1.7.1).
# signature_crossrefs: true
# # also set:
# # separate_signature: true
# show_symbol_type_heading: true
# show_symbol_type_toc: true
- search:
lang: en
watch:
- "src/"
- "docs/"
strict: true
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn