gerd/mkdocs.yml at main · caretech-owl/gerd · 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
site_name: GERD
site_url: https://caretech-owl.github.io/gerd
repo_url: https://github.com/caretech-owl/gerd
copyright: "&copy; 2025 CareTech OWL"

theme:
  name: material
  icon:
    logo: fontawesome/solid/robot
  palette:


    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.instant.progress
    - navigation.footer
    - header.autohide
    - toc.follow
    - toc.integrate
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/solid/globe
      name: CareTech OWL Website
      link: https://caretech-owl.de
    - icon: fontawesome/brands/github
      name: GitHub Organisation
      link: https://github.com/caretech-owl
    - icon: simple/huggingface
      name: Hugging Face Organisation
      link: https://huggingface.co/caretech-owl
markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
nav:
  - "README.md"
  - "concepts.md"
  - "develop.md"
  - "related.md"

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            # docstring_section_style: list # or "table"
            # docstring_style: "numpy"
            filters: ["!^_"]
            heading_level: 1
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_root_heading: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            summary: true
            inherited_members: true
            members_order: alphabetical
            unwrap_annotated: true
            extensions:
              - griffe_inherited_docstrings
            # docstring_section_style: spacy
  - api-autonav:
      modules: ["gerd"]
      nav_section_title: "API Reference"
      api_root_uri: "reference"
      exclude_private: true