-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
98 lines (91 loc) · 2.65 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
site_name: eyepy
site_url: https://example.com/
copyright: Copyright © 2019 - 2023 Olivier Morelle
nav:
- Home: index.md
- Cookbook: cookbook.md
- File formats: formats/
- Reference: reference/
- Changelog: changelog.md
# Plugins
plugins:
- search
- macros:
module_name: docs/main
- autorefs
- gen-files:
scripts:
- docs/gen_ref_pages.py
- docs/gen_e2e_doc.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
handlers:
python:
paths: [src]
options:
docstring_style: google
merge_init_into_class: True
docstring_section_style: table # 'table'/'list'/'spacy'
#show_signature_annotations: True
#separate_signature: True
show_root_toc_entry: True
show_root_heading: True
#show_category_heading: True
heading_level: 1
#show_submodules: True
repo_url: https://github.com/MedVisBonn/eyepy
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
#- navigation.expand
- navigation.footer
#- navigation.indexes # not compatible with toc.integrate
- toc.follow
#- toc.integrate
- navigation.top
- content.code.copy
- content.code.annotate
- header.autohide
icon:
repo: fontawesome/brands/git-alt
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
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.magiclink
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
check_paths: true
base_path: ['.', 'docs/']
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite