-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
140 lines (132 loc) · 3.23 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
site_name: Multi-Modal End-Effector
theme:
favicon: img/magpie.png
logo: img/magpie.png
icon:
repo: fontawesome/brands/github
name: material
features:
- navigation.tabs
- navigation.sections
# - toc.integrate
- navigation.top
- navigation.footer
- navigation.instant
- navigation.expand
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
- header.autohide
- announce.dismiss
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
primary: teal
accent: blue
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
primary: teal
accent: lime
custom_dir: overrides/
markdown_extensions:
- attr_list
- md_in_html
- tables
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- admonition
- pymdownx.details
- pymdownx.tasklist:
clickable_checkbox: true
custom_checkbox: true
- pymdownx.tabbed
- neoteroi.timeline
- neoteroi.cards
extra:
social:
- icon: magpie
link: https://github.com/Suke0811/magpie_sim
generator: true
copyright: Copyright © 2022 - 2024 UCLA RoMeLa
repo_url: https://github.com/Suke0811/magpie_sim
repo_name: Suke0811/magpie_sim
plugins:
- search
- git-revision-date-localized
- git-authors
# - mkdocs-jupyter
# - glightbox
- macros:
include_yaml:
- docs/macros/glob_macros.yaml
# module_name: docs/macros/codes
- table-reader
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_source: true
members_order: source
heading_level: 3
filters: # https://mkdocstrings.github.io/python/usage/configuration/members/#filters
- "!^__" # filter private methods only, showing protected
extra_javascript:
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
- javascripts/tablesort.js
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- css/neoteroi-mkdocs.css
- css/extra.css
nav:
- Home:
- index.md
- Framework:
- md/sim/overall.md
- md/sim/beam.md
- md/sim/mag.md
- md/sim/gru.md
- Data:
- md/data/material.md
- APIs:
- md/api/apis.md
- md/api/mag.md
- md/api/beam.md
- md/api/traj.md