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
|
site_name: magicgui
site_url: https://pyapp-kit.github.io/magicgui
site_description: Type-based GUI creation for Python
repo_name: pyapp-kit/magicgui
repo_url: https://github.com/pyapp-kit/magicgui
edit_uri: edit/main/docs/
# strict: true
copyright: Copyright © 2020 - 2023 Talley Lambert
theme:
name: material
favicon: images/favicon.ico
logo: images/logo.png
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: teal
accent: light-green
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.annotate
- navigation.sections
- navigation.indexes
- toc.follow
- search.suggest
- search.share
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/pyapp-kit/magicgui
name: magicgui on GitHub
- icon: fontawesome/brands/python
link: https://pypi.org/project/magicgui/
name: magicgui on PyPI
nav:
- Overview: index.md
- Installation: installation.md
- Usage:
- widgets.md
- type_map.md
- events.md
- decorators.md
- dataclasses.md
- Examples: generated_examples # This node will automatically be named and have sub-nodes.
- API:
- magicgui: api/magicgui.md
- magic_factory: api/magic_factory.md
- widgets:
- api/widgets/index.md
- api/widgets/*.md
- widgets.bases: api/widgets/bases.md
- widgets.protocols: api/protocols.md
- type_map: api/type_map.md
- application: api/app.md
- experimental: api/experimental.md
- api/migration.md
- Contributing: CONTRIBUTING.md
hooks:
- docs/scripts/_hooks.py
watch:
- src
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight
- pymdownx.extra
- attr_list
- md_in_html
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
- search
- autorefs
- literate-nav
# - section-index
- gen-files:
scripts:
- docs/scripts/_gen_screenshots.py
- docs/scripts/_gen_widgets.py
- gallery:
conf_script: docs/gallery_conf.py
examples_dirs: [docs/examples]
gallery_dirs: [docs/generated_examples]
filename_pattern: /*.py # which scripts will be executed for the docs
ignore_pattern: /__init__.py # ignore these example files completely
run_stale_examples: False
- spellcheck:
backends: # the backends you want to use
- codespell: # or nested configs
dictionaries: [clear, rare]
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://psygnal.readthedocs.io/en/latest/objects.inv
- https://pint.readthedocs.io/en/stable/objects.inv
- https://napari.org/stable/objects.inv
options:
docstring_style: numpy
show_source: false
show_signature_annotations: true
show_root_heading: true
show_root_full_path: true
# show_source: false
show_bases: true
docstring_section_style: list
# special handler only used in _gen_widgets.py
widget_handler:
options:
docstring_style: numpy
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_source: false
show_bases: true
docstring_section_style: list
extra_css:
- stylesheets/extra.css
- stylesheets/pygments.css
|
