-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
176 lines (170 loc) · 4.29 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
site_name: MaPyDe
site_description: Reduce, reuse, and reproduce particle physics phenomenology
site_author: Mike Hance, Giordon Stark
site_url: https://scipp-atlas.github.io/mapyde
repo_name: scipp-atlas/mapyde
repo_url: https://github.com/scipp-atlas/mapyde
edit_uri: blob/main/docs
copyright: "Copyright © Mike Hance, Giordon Stark 2022-present"
docs_dir: docs
site_dir: site
theme:
name: material
custom_dir: docs/.overrides
language: en
favicon: assets/images/logo.svg
icon:
repo: fontawesome/brands/github-alt
logo: material/egg
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to dark mode
features:
- navigation.sections
- navigation.expand
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant
- content.code.copy
- content.code.annotate
nav:
- Home:
- About: index.md
- Installation: install.md
- Introduction: intro.md
- Code Reference: reference/
- CLI:
- About: cli/about.md
- Reference: cli/reference.md
- Meta:
- FAQ: meta/faq.md
- Authors: meta/authors.md
watch:
- src/mapyde
plugins:
# Built-in
search: {}
# Extra
glightbox: {}
minify:
minify_html: true
git-revision-date-localized:
type: date
# Required for generated documentation from gen-files
fallback_to_build_date: true
mike:
alias_type: copy
gen-files:
scripts:
- docs/gen_ref_nav.py
literate-nav:
nav_file: SUMMARY.txt
section-index: {}
mkdocstrings:
default_handler: python
handlers:
python:
paths:
- src
options:
# Headings
show_root_heading: true
show_root_full_path: false
# Docstrings
docstring_style: google
docstring_options:
ignore_init_summary: true
# Signatures/annotations
show_if_no_docstring: false
merge_init_into_class: true
separate_signature: true
show_signature_annotations: true
show_source: true
# Other
filters:
- "!__all__"
- "!^_[^_]"
# to add redirects
#redirects:
# redirect_maps:
# old.md: new_path/old.md
markdown_extensions:
# Built-in
- markdown.extensions.abbr:
- markdown.extensions.admonition:
- markdown.extensions.attr_list:
- markdown.extensions.footnotes:
- markdown.extensions.meta:
- markdown.extensions.tables:
- markdown.extensions.toc:
permalink: true
# Extra
- mkdocs-click:
- pymdownx.arithmatex:
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret:
- pymdownx.critic:
- pymdownx.details:
- pymdownx.emoji:
# https://github.com/twitter/twemoji
# https://raw.githubusercontent.com/facelessuser/pymdown-extensions/master/pymdownx/twemoji_db.py
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
guess_lang: false
linenums_style: pymdownx-inline
use_pygments: true
- pymdownx.inlinehilite:
- pymdownx.keys:
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shortener: true
social_url_shorthand: true
normalize_issue_symbols: true
provider: github
user: scipp-atlas
repo: mapyde
- pymdownx.mark:
- pymdownx.progressbar:
- pymdownx.saneheaders:
- pymdownx.smartsymbols:
- pymdownx.snippets:
check_paths: true
base_path:
- docs/.snippets
- README.md
auto_append:
- links.txt
- abbrs.txt
- pymdownx.superfences:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde:
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/scipp-atlas
extra_css:
- assets/css/custom.css
- https://cdn.jsdelivr.net/gh/tonsky/FiraCode@5.2/distr/fira_code.css