-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
mkdocs.yml
193 lines (186 loc) · 5.17 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
# mkdocs.yml
site_name: "hikari-miru documentation"
site_url: https://miru.hypergonial.com
repo_url: https://github.com/hypergonial/hikari-miru
copyright: Copyright © 2023 hypergonial
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: 'docs/theme'
font:
code: JetBrains Mono
icon:
logo: fontawesome/solid/book
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
toggle:
icon: octicons/sun-16
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
toggle:
icon: octicons/moon-24
name: Switch to light mode
features:
- content.tabs.link
- search.highlight
- search.suggest
- search.share
- content.code.copy
- content.code.select
- navigation.instant
- navigation.instant.progress
- navigation.tabs
- navigation.indexes
- navigation.footer
- navigation.top
- content.action.view
- content.action.edit
- content.tooltips
- toc.follow
- announce.dismiss
nav:
- Home: index.md
- Getting Started: getting_started.md
- Guides:
- guides/index.md
- guides/client_state.md
- guides/editing_items.md
- guides/selects.md
- guides/checks_timeout.md
- guides/error_handling.md
- guides/modals.md
- guides/persistent_views.md
- guides/navigators.md
- guides/menus.md
- guides/migrating_from_v3.md
- API Reference:
- api_reference/index.md
- api_reference/client.md
- Items:
- api_reference/button.md
- api_reference/select.md
- api_reference/text_input.md
- api_reference/view.md
- api_reference/modal.md
- api_reference/context.md
- api_reference/response.md
- api_reference/exceptions.md
- ABC:
- api_reference/abc/item_handler.md
- api_reference/abc/item.md
- api_reference/abc/context.md
- api_reference/abc/select.md
- ext.nav:
- api_reference/ext_nav/index.md
- api_reference/ext_nav/navigator.md
- api_reference/ext_nav/items.md
- ext.menu:
- api_reference/ext_menu/index.md
- api_reference/ext_menu/screen.md
- api_reference/ext_menu/items.md
- api_reference/ext_menu/menu.md
- Changelog:
- changelogs/v4.md
- changelogs/v3.md
- changelogs/v2.md
- changelogs/v1.md
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- toc:
permalink: "#"
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- attr_list
- md_in_html
- tables
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
- autorefs
- search
- social
- privacy
- glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: true
draggable: true
auto_caption: false
caption_position: bottom
skip_classes:
- no-lightbox
- mkdocstrings:
default_handler: python
handlers:
python:
import:
- https://docs.python.org/3.10/objects.inv
- https://docs.hikari-py.dev/en/latest/objects.inv
- https://tanjun.cursed.solutions/objects.inv
- https://alluka.cursed.solutions/objects.inv
- https://arc.hypergonial.com/objects.inv
options:
heading_level: 3
annotations_path: source
members_order: source
group_by_category: true
docstring_section_style: spacy
docstring_style: numpy
inherited_members: true
merge_init_into_class: true
separate_signature: true
show_signature_annotations: true
show_source: false
show_submodules: false
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
extensions:
- griffe_inherited_docstrings
filters:
- "!^_"
- "!^__init_subclass__"
watch:
- docs
- README.md
- miru