chartlets/mkdocs.yml at main · bcdev/chartlets · 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
site_name: chartlets
repo_url: https://github.com/bcdev/chartlets

site_description: Documentation of the chartlet software framework
copyright: Copyright © 2026 Brockmann Consult GmbH


plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [ "chartlets.py" ]
          options:
            show_source: false
            show_if_no_docstring: false
            show_root_heading: true
            show_root_toc_entry: true

nav:
  - Home: index.md
  - Providers Guide: guide/providers.md
  - Contributors Guide: guide/contributors.md
  - Python API:
    - Components: api/components.md
    - Contribution: api/contribution.md
    - Extension: api/extension.md
    - Controllers: api/controllers.md
  - Demo: demo.md
  - About: about.md

theme:
  name: material
  features:
    - toc.integrate  # Ensures TOC is integrated into the sidebar
  locale: en
  #include_sidebar: false
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  custom_dir: docs/overrides

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

extra:
  footer_links:
    - text: "Imprint"
      href: "imprint/"
    - text: "Privacy Policy"
      href: "privacy-policy/"

not_in_nav: |
  imprint.md
  privacy-policy.md