autosar-data-py/mkdocs.yml at main · DanielT/autosar-data-py · 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
site_name: Autosar Data for Python
site_url: "https://danielt.github.io/autosar-data-py"
repo_url: "https://github.com/danielt/autosar-data-py"
repo_name: "danielt/autosar-data-py"
copyright: Copyright &copy; 2025 Daniel Thaler
theme: readthedocs

nav:
  - Home: index.md
  - API documentation:
    - api.md
    - Abstraction:
      - abstraction_api.md
      - Communication: communication_api.md
      - Datatype: datatype_api.md
      - ECU configuration: ecu_configuration_api.md
      - Software Component: software_component_api.md

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            heading_level: 2
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            show_if_no_docstring: true
            filters:
              - "!__"

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - toc:
      permalink: true