docs/mkdocs.yaml at main · modelblocks-org/docs · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: modelblocks
site_url: https://modelblocks.readthedocs.io/
repo_name: docs
repo_url: https://github.com/modelblocks-org/docs/
edit_uri: edit/main/docs/
theme:
  name: material
  features:
  - navigation.footer
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.indexes
  - search.suggest
  - search.highlight
  - toc.follow
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
      primary: teal
      accent: blue grey
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: teal
      accent: blue grey
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference
      primary: teal
      accent: blue grey
markdown_extensions:
  - admonition
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets:
      check_paths: true
      restrict_base_path: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - toc:
      anchorlink: true
plugins:
  - git-committers:
      enabled: true
      repository: modelblocks-org/docs
      branch: main
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_bases: true
            filters:
              - "!^_"
            heading_level: 2
            show_root_heading: true
            merge_init_into_class: true
            show_if_no_docstring: true
            signature_crossrefs: true
            show_root_toc_entry: true
            show_signature_annotations: true
            inherited_members: false
            show_labels: false
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://docs.xarray.dev/en/stable/objects.inv

nav:
  - Home: index.md
  - Background:
    - Background/motivation.md
    - Background/our_framework.md
  - Modules: Modules/modules.md
  - Developer guidelines:
    - Developer_guidelines/getting_started.md
    - Developer_guidelines/requirements.md
    - Developer_guidelines/templates.md

copyright: Copyright &copy; since 2025 <a href="https://github.com/modelblocks-org/docs/blob/main/AUTHORS">modelblocks contributors</a> (Apache 2.0 licensed)