Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
234 lines (220 loc) · 8.58 KB
/
Copy pathmkdocs.yml
File metadata and controls
234 lines (220 loc) · 8.58 KB
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# The name is an acronym: n(ext) g(eneration file format) IO. Lowercased, because the
# project styles itself lowercase everywhere else. What the library actually does is
# spelled out in `site_description` and on the landing page.
site_name: "ngio: next generation file format IO"
# The published docs root (mike serves versions beneath it, e.g. /ngio/stable/).
# This was previously the git clone URL, which produced wrong canonical links and, under
# Zensical, a bogus /BioVisionCenter/ngio.git/ base path when serving locally.
site_url: "https://biovisioncenter.github.io/ngio/"
site_description: "A Python library for OME-Zarr bioimage analysis"
repo_name: "ngio"
repo_url: "https://github.com/BioVisionCenter/ngio"
copyright: "Copyright © 2024-2026, BioVisionCenter UZH"
# GitHub's default branch here is `main`. Zensical would otherwise derive
# `edit/master/docs` (config.py:439-453) and every edit link would 404.
edit_uri: edit/main/docs/
# The snippet scripts are executed into the docs via pymdownx.snippets, which reads them
# from the filesystem rather than from the page tree.
# NOTE: Zensical does not honour `exclude_docs`, so the .py files are still copied into
# the built site as static assets (they are not rendered as pages). Harmless — they are
# already public in the repo — but that is why they show up under site/snippets/.
exclude_docs: |
snippets/
theme:
name: material
logo: assets/logo.svg
favicon: assets/logo.svg
icon:
repo: fontawesome/brands/github
# Space Grotesk (display face) is loaded from ngio.css; theme.font only
# manages the text and code families.
font:
text: IBM Plex Sans
code: JetBrains Mono
# The real brand palette lives in stylesheets/ngio.css as variable overrides;
# config only picks the nearest stock name so the toggle behaves.
palette:
# Palette toggle for light mode
- scheme: default
primary: teal
accent: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: teal
accent: teal
toggle:
icon: material/brightness-4
name: Switch to light mode
# Only flags Zensical's templates actually read are listed. Previously enabled but
# absent from zensical/templates/, i.e. dead config: navigation.instant, toc.follow,
# search.suggest, search.share.
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant.progress
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
extra_css:
- stylesheets/ngio.css
extra:
homepage: https://biovisioncenter.github.io/ngio/
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: "https://github.com/BioVisionCenter/ngio"
name: ngio on GitHub
- icon: fontawesome/brands/python
link: "https://pypi.org/project/ngio/"
name: ngio on PyPI
- icon: fontawesome/solid/microscope
link: "https://www.biovisioncenter.uzh.ch/en.html"
name: BioVisionCenter, University of Zurich
plugins:
- search
- autorefs
- markdown-exec
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
options:
heading_level: 3
docstring_style: google
show_source: true
show_signature_annotations: true
show_root_heading: true
show_root_full_path: true
show_bases: true
docstring_section_style: list
extensions:
- griffe_typingdoc
show_if_no_docstring: true
inherited_members: true
members_order: source
separate_signature: true
unwrap_annotated: false
filters:
- '!^_'
merge_init_into_class: true
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
# IMPORTANT: declaring this key REPLACES Zensical's ~30 defaults rather than extending
# them (zensical/config.py:656 — `config.get("markdown_extensions", DEFAULT_...)`), so
# everything we rely on must be listed here explicitly. Omitting `tables` is what once
# made pipe tables render as literal `|---|` text; omitting `attr_list` silently broke
# `content.code.annotate`, and omitting `abbr` broke `content.tooltips`.
# Deliberately NOT restored from Zensical's defaults:
# pymdownx.smartsymbols — rewrites `<--` to an arrow, and every snippet include
# contains `--8<--`; not worth the risk for the gain.
# pymdownx.caret / tilde — turn `^x^` / `~x~` into super/subscript, a latent trap in
# prose about array axes and dtypes.
# pymdownx.magiclink — changes how bare URLs render across existing pages.
# pymdownx.arithmatex — no maths in these docs.
markdown_extensions:
- abbr # glossary tooltips (with content.tooltips)
- admonition
- attr_list # grid cards, code annotations, link attributes
- def_list
- footnotes
- md_in_html
- tables
- pymdownx.details
# NB: zensical.extensions.emoji, not material.extensions.emoji — mkdocs-material is
# not installed since the Zensical migration.
- pymdownx.emoji:
emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
emoji_index: !!python/name:zensical.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.snippets:
base_path: ["."]
check_paths: true
auto_append:
- docs/_glossary.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: true
toc_depth: 3
# Nav labels are sentence case, like every other heading and title on the site.
# Initialisms (OME-Zarr, HCS, ROI, API) keep their capitals; the common nouns
# beside them do not. "Code of Conduct" is the exception: that is the proper
# name of the Contributor Covenant document, not a description.
nav:
- Home: index.md
- Getting started:
- "Quickstart": getting_started/0_quickstart.md
- "OME-Zarr containers": getting_started/1_ome_zarr_containers.md
- "Images and labels": getting_started/2_images.md
- "Tables": getting_started/3_tables.md
- "Masked images and labels": getting_started/4_masked_images.md
- "HCS plates": getting_started/5_hcs.md
- "Iterators": getting_started/6_iterators.md
- "Configuration": getting_started/7_configuration.md
- Tutorials:
- "Create an OME-Zarr image": tutorials/create_ome_zarr.md
- "Image processing": tutorials/image_processing.md
- "Image segmentation": tutorials/image_segmentation.md
- "Stitching": tutorials/stitching.md
- "Object detection": tutorials/object_detection.md
- "Feature extraction": tutorials/feature_extraction.md
- "Distributed processing": tutorials/distributed_processing.md
- "HCS exploration": tutorials/hcs_exploration.md
- Table specifications:
- "Overview": table_specs/overview.md
- "Table backends": table_specs/backend.md
- "Table types":
- "Generic table": table_specs/table_types/generic_table.md
- "ROI table": table_specs/table_types/roi_table.md
- "Masking ROI table": table_specs/table_types/masking_roi_table.md
- "Feature table": table_specs/table_types/feature_table.md
- "Condition table": table_specs/table_types/condition_table.md
- "Add a custom table": table_specs/table_types/custom_table.md
- API reference:
- "OmeZarrContainer": api/ome_zarr_container.md
- "Images": api/images.md
- "HCS": api/hcs.md
- "Tables": api/tables.md
- "Iterators": api/iterators.md
- "ngio":
- "ngio": api/ngio/ngio.md
- "ngio.common": api/ngio/common.md
- "ngio.config": api/ngio/config.md
- "ngio.io_pipes": api/ngio/io_pipes.md
- "ngio.iterators": api/ngio/iterators.md
- "ngio.images": api/ngio/images.md
- "ngio.tables": api/ngio/tables.md
- "ngio.hcs": api/ngio/hcs.md
- "ngio.transforms": api/ngio/transforms.md
- "ngio.utils": api/ngio/utils.md
- changelog.md
- Contributing:
- "Contributing guide": contributing.md
- "Code of Conduct": code_of_conduct.md