thyra/mkdocs.yml at main · M4i-Imaging-Mass-Spectrometry/thyra · 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
site_name: Thyra
site_description: A modern Python library for converting Mass Spectrometry Imaging data into SpatialData/Zarr format
site_url: https://M4i-Imaging-Mass-Spectrometry.github.io/thyra
repo_url: https://github.com/M4i-Imaging-Mass-Spectrometry/thyra
repo_name: M4i-Imaging-Mass-Spectrometry/thyra

theme:
  name: material
  font: false  # Use brand fonts from extra.css instead of Google Fonts
  icon:
    logo: material/door-open
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - search.highlight
    - toc.follow

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 3
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - tables

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - CLI Reference: cli.md
  - Output Format: output-format.md
  - API Reference: api.md
  - Contributing: contributing.md
  - Code of Conduct: code-of-conduct.md
  - Changelog: changelog.md