-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
215 lines (202 loc) · 8.02 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
site_name: MkDoxy Demo
site_url: https://mkdoxy-demo.kubaandrysek.cz/
site_author: Jakub Andrýsek
site_description: >-
This is a demo of MkDoxy, a tool for generating Doxygen documentation from Markdown files.
# Repository
repo_name: JakubAndrysek/MkDoxy-demo
repo_url: https://github.com/JakubAndrysek/MkDoxy-demo
# Copyright
copyright: Copyright © 2023 Jakub Andrýsek
theme:
name: material
language: en
logo: assets/logo.png
favicon: assets/logo.png
features:
- navigation.tabs
- navigation.indexes
- navigation.top
- navigation.instant
- navigation.tracking
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: amber
accent: amber
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: amber
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/JakubAndrysek
- icon: fontawesome/brands/twitter
link: https://twitter.com/KubaAndrysek
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/jakub-andrysek/
analytics:
provider: google
property: G-6VB0GPP3MT
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!
use_directory_urls: True
#use_directory_urls: False
plugins:
- search
- glightbox
- open-in-new-tab
- mkdoxy:
projects:
esp:
src-dirs: demo-projets/esp
full-doc: True
template-dir: templates-custom
# Example of custom template: https://mkdoxy-demo.kubaandrysek.cz/esp/annotated/
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h*"
EXAMPLE_PATH: examples
RECURSIVE: True
animal:
src-dirs: demo-projets/animal
full-doc: True
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h*"
EXAMPLE_PATH: examples
RECURSIVE: True
stm:
src-dirs: demo-projets/stm32
full-doc: True
jaculus:
src-dirs: demo-projets/jaculus/main demo-projets/jaculus/managed_components/jac-link demo-projets/jaculus/managed_components/jac-machine
full-doc: True
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h*"
EXAMPLE_PATH: examples
RECURSIVE: True
save-api: .mkdoxy
full-doc: True
debug: False
ignore-errors: False
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
nav:
- "Home": "README.md"
- useage.md
- API Demo:
- api/index.md
- ESP-32:
- esp/index.md
- "Links": "esp/links.md"
- "Classes":
- "Class List": "esp/annotated.md"
- "Class Index": "esp/classes.md"
- "Class Hierarchy": "esp/hierarchy.md"
- "Class Members": "esp/class_members.md"
- "Class Member Functions": "esp/class_member_functions.md"
- "Class Member Variables": "esp/class_member_variables.md"
- "Class Member Typedefs": "esp/class_member_typedefs.md"
- "Class Member Enumerations": "esp/class_member_enums.md"
- "Namespaces":
- "Namespace List": "esp/namespaces.md"
- "Namespace Members": "esp/namespace_members.md"
- "Namespace Member Functions": "esp/namespace_member_functions.md"
- "Namespace Member Variables": "esp/namespace_member_variables.md"
- "Namespace Member Typedefs": "esp/namespace_member_typedefs.md"
- "Namespace Member Enumerations": "esp/namespace_member_enums.md"
- "Functions": "esp/functions.md"
- "Variables": "esp/variables.md"
- "Macros": "esp/macros.md"
- "Files": "esp/files.md"
- STM-32:
- stm32/index.md
- "Links": "stm/links.md"
- "Classes":
- "Class List": "stm/annotated.md"
- "Class Index": "stm/classes.md"
- "Class Hierarchy": "stm/hierarchy.md"
- "Class Members": "stm/class_members.md"
- "Class Member Functions": "stm/class_member_functions.md"
- "Class Member Variables": "stm/class_member_variables.md"
- "Class Member Typedefs": "stm/class_member_typedefs.md"
- "Class Member Enumerations": "stm/class_member_enums.md"
- "Namespaces":
- "Namespace List": "stm/namespaces.md"
- "Namespace Members": "stm/namespace_members.md"
- "Namespace Member Functions": "stm/namespace_member_functions.md"
- "Namespace Member Variables": "stm/namespace_member_variables.md"
- "Namespace Member Typedefs": "stm/namespace_member_typedefs.md"
- "Namespace Member Enumerations": "stm/namespace_member_enums.md"
- "Functions": "stm/functions.md"
- "Variables": "stm/variables.md"
- "Macros": "stm/macros.md"
- "Files": "stm/files.md"
- Animal:
- animal/index.md
- "Links": "animal/links.md"
- "Classes":
- "Class List": "animal/annotated.md"
- "Class Index": "animal/classes.md"
- "Class Hierarchy": "animal/hierarchy.md"
- "Class Members": "animal/class_members.md"
- "Class Member Functions": "animal/class_member_functions.md"
- "Class Member Variables": "animal/class_member_variables.md"
- "Class Member Typedefs": "animal/class_member_typedefs.md"
- "Class Member Enumerations": "animal/class_member_enums.md"
- "Namespaces":
- "Namespace List": "animal/namespaces.md"
- "Namespace Members": "animal/namespace_members.md"
- "Namespace Member Functions": "animal/namespace_member_functions.md"
- "Namespace Member Variables": "animal/namespace_member_variables.md"
- "Namespace Member Typedefs": "animal/namespace_member_typedefs.md"
- "Namespace Member Enumerations": "animal/namespace_member_enums.md"
- "Functions": "animal/functions.md"
- "Variables": "animal/variables.md"
- "Macros": "animal/macros.md"
- "Files": "animal/files.md"
- Jaculus:
- jaculus/index.md
- "Links": "jaculus/links.md"
- "Classes":
- "Class List": "jaculus/annotated.md"
- "Class Index": "jaculus/classes.md"
- "Class Hierarchy": "jaculus/hierarchy.md"
- "Class Members": "jaculus/class_members.md"
- "Class Member Functions": "jaculus/class_member_functions.md"
- "Class Member Variables": "jaculus/class_member_variables.md"
- "Class Member Typedefs": "jaculus/class_member_typedefs.md"
- "Class Member Enumerations": "jaculus/class_member_enums.md"
- "Namespaces":
- "Namespace List": "jaculus/namespaces.md"
- "Namespace Members": "jaculus/namespace_members.md"
- "Namespace Member Functions": "jaculus/namespace_member_functions.md"
- "Namespace Member Variables": "jaculus/namespace_member_variables.md"
- "Namespace Member Typedefs": "jaculus/namespace_member_typedefs.md"
- "Namespace Member Enumerations": "jaculus/namespace_member_enums.md"
- "Functions": "jaculus/functions.md"
- "Variables": "jaculus/variables.md"
- "Macros": "jaculus/macros.md"
- "Files": "jaculus/files.md"