-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
158 lines (150 loc) · 4.37 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
# Define the skeleton of the website/documentation
site_name: openhdemg
site_author: Giacomo Valli & Paul Ritsche
site_description: >-
All you need to know about openhdemg
# Repository
repo_name: openhdemg
repo_url: https://github.com/GiacomoValliPhD/openhdemg
copyright: Copyright © 2022 - 2024. The openhdemg community
theme:
name: material
custom_dir: docs/overrides
logo: yml_graphics/transp_icon.png
favicon: yml_graphics/transp_icon.png
features:
- content.code.copy
- announce.dismiss
- navigation.top
palette:
# 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 light mode
extra_css: [docs/custom.css]
# Select a plugin to get the docs from docstrings and setup the numpy stile as
# the default style.
# In order change the docstring_style we need to access:
# mkdocstrings/python/src/mkdocstrings_handlers/python/handler.py
plugins:
- mkdocstrings:
handlers:
python:
options:
docstring_style: 'numpy'
docstring_section_style: 'spacy'
show_source: false
docstring_options:
ignore_init_summary: True
- search:
lang: en
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- tags:
# Specify custom pages-menu order.
# If you don’t like a page’s title, you can optionally add another element in
# front of the filename whose title you want to change.
nav:
- Welcome: index.md
- About us: about-us.md
- Quick-Start: quick-start.md
- Tutorials:
#- Overview on the tutorials: Tutorials.md
- For new users:
- Setup working environment: tutorials/setup_working_env.md
- Basics of openhdemg:
- Structure of the emgfile: tutorials/emgfile_structure.md
- Import from other software: tutorials/import_from_other_software.md
- Move to newer versions:
- Convert old .json files: tutorials/convert_old_json_files.md
- Graphical Interface:
- Intro: gui_intro.md
- Basics: gui_basics.md
- Advanced: gui_advanced.md
- Settings: gui_settings.md
- What's New: what's-new.md
- Contacts: contacts.md
- Cite us: cite-us.md
- Contribute: contribute.md
- ISEK-JEK Tutorials: isek_jek_tutorials.md
- API Reference:
- openfiles: api_openfiles.md
- plotemg: api_plotemg.md
- analysis: api_analysis.md
- pic: api_pic.md
- tools: api_tools.md
- mathtools: api_mathtools.md
- muap: api_muap.md
- electrodes: api_electrodes.md
- info: api_info.md
- compatibility: api_compatibility.md
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
title: On this page
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- 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.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: GiacomoValliPhD
repo: openhdemg
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Modify extra tools.
extra:
generator: false # Remove 'Made with Material for MkDocs' in the footer.
social:
- icon: fontawesome/brands/github
link: https://github.com/GiacomoValliPhD/openhdemg
- icon: fontawesome/brands/twitter
link: https://twitter.com/openhdemg
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@openhdemg
# version:
# provider: mike # TODO versioning
# Need to have or pip install:
# mkdocs
# mkdocs-autorefs
# mkdocs-material
# mkdocs-material-extensions
# mkdocstrings
# mkdocstrings-python
# mike