-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
137 lines (132 loc) · 3.27 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
site_name: ULPatch Docs
site_url: https://rtoax.github.io/ulpatch/
repo_url: https://github.com/Rtoax/ulpatch
repo_name: Rtoax/ulpatch
copyright: Copyright © 2021 - 2024 Rong Tao
nav:
- Home: index.md
- Installation: INSTALL.md
- Theory: theory.md
- Tutorials:
- Code Style: code-style.md
- Developer: developers.md
- Log: LOG.md
- Contributing: CONTRIBUTING.md
- Knowledge:
- Relocations: relocations.md
- Symbol Value: symbol-value.md
- Releases: RELEASE.md
theme:
name: material
logo: images/logo.drawio.svg
favicon: images/logo.drawio.svg
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/weather-night
name: Switch to light mode
features:
# - navigation.instant # see https://github.com/ultrabug/mkdocs-static-i18n/issues/62
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.indexes
- navigation.top
- navigation.footer
- toc.follow
- search.highlight
- search.share
- search.suggest
- content.action.view
- content.action.edit
- content.tabs.link
- content.code.copy
- content.code.select
- content.code.annotations
markdown_extensions:
# Officially Supported Extensions
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- meta
- sane_lists
- tables
- toc:
permalink: true
- wikilinks
# Third Party Extensions(Bundles, PyMdown Extensions)
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search
- include-markdown
- mkdocstrings:
default_handler: python
handlers:
python:
options:
# Headings
show_root_heading: true
show_root_toc_entry: true
show_object_full_path: true
# Members
show_submodules: false
# Docstrings
docstring_section_style: spacy
- i18n:
docs_structure: folder
fallback_to_default: true
languages:
- locale: en
default: true
name: English
- locale: zh
default: false
name: 中文
nav_translations:
Home: 主页
Installation: 安装
Theory: 原理
Tutorials: 教程
Code Style: 代码风格
Developer: 开发者
Log: 日志
Contributing: 贡献
Knowledge: 相关知识
Relocations: 重定向
Symbol Value: 符号地址
Releases: 发布
extra:
generator: false
social:
- icon: fontawesome/solid/paper-plane
link: mailto:[email protected]
- icon: fontawesome/brands/github
link: https://github.com/Rtoax/ulpatch