-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmkdocs.yml
259 lines (247 loc) · 8.84 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: pytauri
site_url: https://WSH032.github.io/pytauri/
repo_url: https://github.com/WSH032/pytauri/
repo_name: WSH032/pytauri
edit_uri: edit/main/docs/
theme:
name: material
icon:
logo: octicons/rocket-24 # TODO: new logo for pytauri
favicon: images/rocket-24.svg # TODO: new logo for pytauri
features:
- content.code.copy
- content.code.annotate
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.instant.preview
- navigation.top
- navigation.tabs
- navigation.path
# - navigation.expand
# - navigation.tracking
- search.suggest
- search.highlight
- search.share
- navigation.footer
- content.action.edit
- content.action.view
- content.tabs.link
- content.tooltips
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#system-preference
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.snippets
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# class: mermaid
# format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
# # for static build
# # see: https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/
# - offline
# - privacy
#
# # for optimized build
# see: https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/
# - optimize
- search
- gen-files:
scripts:
- utils/gen_ref_pages.py
# see: <https://mkdocstrings.github.io/recipes/#generate-a-literate-navigation-file>
- literate-nav:
# DO NOT change `SUMMARY.md`, it's used in `utils/gen_ref_pages.py`
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
# Modified: https://github.com/mkdocstrings/python/blob/eaf9b8240069f7369f401fe048892043c8b173d3/mkdocs.yml#L140-L166
default_handler: python
handlers:
python:
import:
# see: https://mkdocstrings.github.io/python/usage/#import
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
- https://anyio.readthedocs.io/en/stable/objects.inv
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
options:
docstring_style: google
members_order: source
preload_modules:
# see: <https://mkdocstrings.github.io/python/usage/configuration/general/#preload_modules>
# set these also for `[options.paths]`
- codelldb
- pyo3_utils
- pytauri
- pytauri_plugin_notification
extensions:
# https://mkdocstrings.github.io/griffe-inherited-docstrings/
- griffe_inherited_docstrings
# https://mkdocstrings.github.io/griffe-pydantic/
- griffe_pydantic
# https://mkdocstrings.github.io/griffe-warnings-deprecated/
- griffe_warnings_deprecated
# https://mkdocstrings.github.io/python/usage/configuration/headings/#parameter_headings
parameter_headings: true
# https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_if_no_docstring
show_if_no_docstring: true
# https://mkdocstrings.github.io/python/usage/configuration/docstrings/?h=merge_init_into_class#merge_init_into_class
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/?h=heading_level#show_root_heading
heading_level: 1
show_root_heading: true
# https://mkdocstrings.github.io/python/usage/configuration/members/?h=inherited_members#inherited_members
inherited_members: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc
show_symbol_type_toc: true
show_symbol_type_heading: true
# https://mkdocstrings.github.io/python/usage/configuration/members/?h=summary#summary
summary: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/?h=unwrap_annotated#unwrap_annotated
unwrap_annotated: true
paths:
# set these also for `[options.preload_modules]`
- python/codelldb/src
- python/pyo3-utils/src
- python/pytauri/src
- python/pytauri-plugin-notification/src
# Remember: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin#note-when-using-build-environments
- git-revision-date-localized:
fallback_to_build_date: true
enable_creation_date: true
type: timeago
- git-committers:
repository: WSH032/pytauri
branch: main
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/WSH032/
# see: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
version:
provider: mike
watch:
- python/
- docs_src/
- README.md
- CONTRIBUTING.md
- CHANGELOG.md
# py
- python/pytauri/CHANGELOG.md
- python/pytauri-plugin-notification/CHANGELOG.md
- python/pyo3-utils/CHANGELOG.md
- python/codelldb/CHANGELOG.md
# rs
- crates/pytauri/CHANGELOG.md
- crates/pytauri-core/CHANGELOG.md
- crates/tauri-plugin-pytauri/CHANGELOG.md
- crates/pytauri-plugin-notification/CHANGELOG.md
- crates/pyo3-utils/CHANGELOG.md
# js
- crates/tauri-plugin-pytauri/guest-js/CHANGELOG.md
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
# Don't change the name "reference/"
# It's used in utils/gen_ref_pages.py
nav:
- Home: index.md
- Usage:
- Tutorial:
- usage/tutorial/index.md
- usage/tutorial/getting-started.md
- usage/tutorial/using-pytauri.md
- usage/tutorial/py-js-ipc.md
- usage/tutorial/using-plugins.md
- usage/tutorial/build-sdist.md
- usage/tutorial/build-wheel.md
- usage/tutorial/build-standalone.md
- Concepts:
- usage/concepts/index.md
- usage/concepts/ipc.md
# DO NOT change `reference/`, it's used in `utils/gen_ref_pages.py`
- API Reference: reference/
- CONTRIBUTING:
- CONTRIBUTING/index.md
- CHANGELOG:
- CHANGELOG/index.md
# NOTE: must set the title for the first item, or it will be considered as `index`.
# see: <https://github.com/oprypin/mkdocs-section-index/issues/6#issuecomment-914666358>
- py:
- pytauri: CHANGELOG/py/pytauri.md
- pytauri-plugin-notification: CHANGELOG/py/pytauri-plugin-notification.md
- pyo3-utils: CHANGELOG/py/pyo3-utils.md
- codelldb: CHANGELOG/py/codelldb.md
- rs:
- pytauri: CHANGELOG/rs/pytauri.md
- pytauri-core: CHANGELOG/rs/pytauri-core.md
- tauri-plugin-pytauri: CHANGELOG/rs/tauri-plugin-pytauri.md
- pytauri-plugin-notification: CHANGELOG/rs/pytauri-plugin-notification.md
- pyo3-utils: CHANGELOG/rs/pyo3-utils.md
- js:
- tauri-plugin-pytauri-api: CHANGELOG/js/tauri-plugin-pytauri-api.md