rayx/mkdocs.yml at master · hz-b/rayx · 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
# yaml-language-server : $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: RAYX
site_url: https://hz-b.github.io/rayx/
repo_url: https://github.com/hz-b/rayx
repo_name: hz-b/rayx
edit_uri: edit/master/docs/
site_author: Helmholtz-Zentrum Berlin für Materialien und Energie (HZB)
site_description: RAYX is a powerful, multi-component simulation platform designed to streamline the design and optimization of beamlines in synchrotron light source facilities.
copyright: ©HZB 2026

# nav entry overwritten by awesome-nav plugin which allows folders and provides globs, see: .nav.yml

plugins:
  - search
  - awesome-nav:
      filename: .nav.yml
  - mkdoxy:
      enabled: !ENV [ENABLE_MKDOXY, True]
      save-api: .mkdoxy
      # full-doc: True
      # debug: False
      # ignore-errors: False
      projects:
        rayxCore: # using rayx-core as project name resulted in errors when using snippets
          src-dirs: Intern/rayx-core/src
          full-doc: True
          # doxy-cfg-file: Intern/rayx-core/doc/doxyfile
          doxy-cfg:
            FILE_PATTERNS: "*.h"
            RECURSIVE: True
            GENERATE_XML: True  # needed by mkdoxy, otherwise the build will crash
  - mike:
      canonical_version: latest # version to point search engines to

extra:
  version:
    provider: mike

validation:
  omitted_files: info # mkdoxy api docs are linked on pages but not included in nav
  absolute_links: warn
  unrecognized_links: warn
  not_found: warn
  anchors: warn

theme:
  name: material
  logo: res/rayx-logo_48x48.png
  favicon: res/rayx-logo_48x48.png
  features:
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - navigation.tabs.sticky
    - navigation.sections
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      # primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      # primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
      # combine_header_slug: true
  - pymdownx.details            # collapsible admonitions with ???
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # Maybe needed for MkDoxy snippets?
  - pymdownx.blocks.html:
  - pymdownx.blocks.definition:
  - pymdownx.blocks.tab:


extra_javascript:
  - js/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js