core-bioimage-io-python/mkdocs.yaml at main · bioimage-io/core-bioimage-io-python · GitHub

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
site_name: 'bioimageio.core'
site_url: 'https://bioimage-io.github.io/core-bioimage-io-python'
site_author: Fynn Beuttenmüller
site_description: 'Python specific core utilities for bioimage.io resources (in particular DL models).'

repo_name: bioimage-io/core-bioimage-io-python
repo_url: https://github.com/bioimage-io/core-bioimage-io-python
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette:
    - media: '(prefers-color-scheme)'
      primary: 'indigo'
      accent: 'orange'
      toggle:
        icon: material/brightness-auto
        name: 'Switch to light mode'
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: 'indigo'
      accent: 'orange'
      toggle:
        icon: material/brightness-7
        name: 'Switch to dark mode'
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: 'indigo'
      accent: 'orange'
      toggle:
        icon: material/brightness-4
        name: 'Switch to system preference'

  font:
    text: Roboto
    code: Roboto Mono

  logo: images/bioimage-io-icon.png
  favicon: images/favicon.ico

plugins:
  - autorefs
  - coverage:
      html_report_dir: dist/coverage
  - gen-files:
      scripts:
        - scripts/generate_api_doc_pages.py
  - markdown-exec:
      ansi: required
  - mkdocstrings:
      enable_inventory: true
      default_handler: python
      locale: en
      handlers:
        python:
          inventories:
            - https://docs.pydantic.dev/latest/objects.inv
            - https://bioimage-io.github.io/spec-bioimage-io/v0.5.9.1/objects.inv
          options:
            annotations_path: source
            backlinks: tree
            docstring_options:
              ignore_init_summary: true
              returns_multiple_items: false
              returns_named_value: false
              trim_doctest_flags: true
            # docstring_section_style: spacy
            docstring_style: google
            filters: public
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            preload_modules: [pydantic, bioimageio.spec]
            scoped_crossrefs: true
            separate_signature: true
            show_docstring_examples: true
            show_if_no_docstring: true
            show_inheritance_diagram: true
            show_root_full_path: false
            show_root_heading: true
            show_signature_annotations: true
            show_signature_type_parameters: true
            show_source: true
            show_submodules: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            unwrap_annotated: false
            extensions:
              - griffe_pydantic:
                  schema: true
              - griffe_inherited_docstrings
              - griffe_public_redundant_aliases
  - mike:
      alias_type: redirect
      canonical_version: latest
      version_selector: true
  - literate-nav:
      nav_file: SUMMARY.md
  - search
  - section-index

markdown_extensions:
  - attr_list
  - admonition
  - callouts:
      strip_period: false
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: '¤'
      permalink_title: Anchor link to this section for reference
      toc_depth: 2

nav:
  - Home:
      - index.md
      - Get started: get_started.md
      - Installation: installation.md
      - bioimageio CLI: cli.md
      - Use in Python: use_in_python.md
      - Compatibility: compatibility.md
  - API Reference: api/
  - Changelog: changelog.md
  - Coverage report: coverage.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bioimage-io
  version:
    provider: mike
    alias: true