zmbt-framework/mkdocs.yml at main · zenseact/zmbt-framework · 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
site_name: Zenseact MBT Framework
copyright: |-
  Copyright &copy; 2022-2023 Volvo Car Corporation //
  Copyright &copy; 2024-2025 Zenseact AB
repo_url: https://github.com/zenseact/zmbt-framework
# docs_dir: '.'

strict: !ENV [ENABLE_MKDOXY, True]
hooks:
  - docs/hooks/preprocessor.py
nav:
  - Home: index.md
  # - Overview:
  # - Installation:
  # - Quick Start:
  - User Guide:
      - Signal Mapping Model: user-guide/signal-mapping.md
      - user-guide/expressions.md
      - user-guide/environment.md
      - user-guide/reflection.md
      - user-guide/concepts.md
  - DSL Reference:
      # - dsl-reference/overview.md
      - dsl-reference/signal-mapping.md
      - dsl-reference/expressions.md

  - C++ API:
    # - "CxxRef/links.md"
    - "Namespaces":
        - "Namespace List": "CxxRef/namespaces.md"
        - "Namespace Members": "CxxRef/namespace_members.md"
        - "Namespace Member Functions": "CxxRef/namespace_member_functions.md"
        - "Namespace Member Variables": "CxxRef/namespace_member_variables.md"
        - "Namespace Member Typedefs": "CxxRef/namespace_member_typedefs.md"
        - "Namespace Member Enumerations": "CxxRef/namespace_member_enums.md"
    - "Classes":
        - "Class List": "CxxRef/annotated.md"
        - "Class Index": "CxxRef/classes.md"
        - "Class Hierarchy": "CxxRef/hierarchy.md"
        - "Class Members": "CxxRef/class_members.md"
        - "Class Member Functions": "CxxRef/class_member_functions.md"
        - "Class Member Variables": "CxxRef/class_member_variables.md"
        - "Class Member Typedefs": "CxxRef/class_member_typedefs.md"
        - "Class Member Enumerations": "CxxRef/class_member_enums.md"
    - "Macros": "CxxRef/macros.md"
    - "Files": "CxxRef/files.md"

theme:
  favicon: images/zenseact-logo.svg
  logo: images/zenseact-logo.svg
  name: material
  language: en
  features:
    - content.code.select
    - content.code.copy
    - content.code.annotate
    - navigation.footer
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra:
  version:
    provider: mike

plugins:
  - search
  - tags
  - plantuml: # mkdocs_puml
      puml_url: https://www.plantuml.com/plantuml/
      puml_keyword: plantuml
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: latest
      version_selector: true
      css_dir: css
      javascript_dir: js

  - mkdoxy:
      enabled: !ENV [ENABLE_MKDOXY, True]
      projects:
        CxxRef: # name of project must be alphanumeric + numbers (without spaces)
          src-dirs: zmbt-framework/backends/cxx # path to source code (support multiple paths separated by space) => INPUT
          # full-doc: True # if you want to generate full documentation
          doxy-cfg-file: docs/doxygen/Doxyfile
          doxy-cfg: # standard doxygen configuration (key: value)
            FILE_PATTERNS: "*.hpp* *.dox *.md" # specify file patterns to filter out
            RECURSIVE: True # recursive search in source directories

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

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