ndv/mkdocs.yml at main · pyapp-kit/ndv · 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
site_name: "ndv"
site_url: https://pyapp-kit.github.io/ndv/
site_description: "minimal n-dimensional python array viewer."
repo_name: "pyapp-kit/ndv"
repo_url: https://github.com/pyapp-kit/ndv
watch: [mkdocs.yml, README.md, src]

# maximum strictness
# https://www.mkdocs.org/user-guide/configuration/#validation
strict: true
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

nav:
  - Home: index.md
  - install.md
  - usage.md
  - motivation.md
  - env_var.md
  - Cookbook:
      - cookbook/embedding.md
      - cookbook/streaming.md
  # This is populated by api-autonav plugin
  # - API reference: reference/

theme:
  name: material
  custom_dir: docs/_overrides
  icon:
    logo: material/cube-scan
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
    - navigation.footer
    - navigation.sections
    - toc.follow

extra_css:
  - css/material.css
  - css/ndv.css
  - css/install-table.css

extra_javascript:
  - js/install-table.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      pygments_lang_class: true
      line_spans: __span
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "#"

plugins:
  - autorefs:
      resolve_closest: true
  - search
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      cache_safe: true
  - spellcheck:
      backends:
        - codespell:
            dictionaries: [clear]
  - api-autonav:
      modules: [src/ndv]
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://cmap-docs.readthedocs.io/objects.inv
            - https://psygnal.readthedocs.io/en/latest/objects.inv
          options:
            docstring_section_style: list
            docstring_style: "numpy"
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            preload_modules: [ndv]
            relative_crossrefs: true
            scoped_crossrefs: true
            separate_signature: true
            # show_bases: false
            # show_inheritance_diagram: true
            show_root_heading: true
            # show_root_full_path: false
            show_signature_annotations: true
            # show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            unwrap_annotated: true

hooks:
  - docs/hooks.py

extra:
  version:
    provider: mike
  # either of these tags will enable the "viewing pre" announcement banner
  # see _overrides/main.html
  pre_release: !ENV ["DOCS_PRERELEASE", false]
  dev_build: !ENV ["DOCS_DEV", false]
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pyapp-kit
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ndv/