pde-transformer/mkdocs.yml at main · tum-pbs/pde-transformer · 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
site_name: PDE-Transformer
site_description: Efficient and Versatile Transformers for Physics Simulations
site_author: Benjamin Holzschuh
site_url: https://tum-pbs.github.io/pde-transformer
repo_url: https://github.com/tum-pbs/pde-transformer
repo_name: tum-pbs/pde-transformer


use_directory_urls: false

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/img/favicon.png
  logo: assets/img/logo.png

extra_css:
  - assets/css/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [../src]
          options:
            show_source: true
  - git-revision-date-localized:
      enable_creation_date: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tum-pbs/pde-transformer
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pdetransformer
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

nav:
  - Documentation:
    - Overview: index.md
    - Getting Started: getting_started.md
    - Model Types:
        - Mixed Channel: mixed_channel.md
        - Separate Channel: separate_channel.md
    - Training Setups: training.md
    - Datasets:
        - Overview: datasets/overview.md
        - APE 2D: datasets/ape_2d.md
        - The Well: datasets/the_well.md
    - Pretrained Models: pretrained-weights.md