signalbot/mkdocs.yml at main · signalbot-org/signalbot · 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
site_name: Signalbot
site_description: Documentation for Signalbot, a Python library for building Signal bots using the signal-cli-rest-api.
site_author: Era Dorta
site_url: https://signalbot-org.github.io/signalbot/

repo_url: https://github.com/signalbot-org/signalbot
repo_name: signalbot-org/signalbot

nav:
  - Overview: index.md
  - Getting started: getting_started.md
  - Examples:
      - API overview: examples/api_overview.md
      - Bot config: examples/bot_config_options.md
      - Scheduler: examples/bot_with_scheduler.md
  - Additional information: additional_information.md
  - Reference:
      - SignalBot: reference/bot.md
      - Config: reference/bot_config.md
      - Message: reference/message.md
      - Context: reference/context.md
      - LinkPreview: reference/linkpreview.md
      - Command: reference/command.md
      - Quote: reference/quote.md
      - Reaction: reference/reaction.md
  - Troubleshooting: troubleshooting.md
  - Contributing: local_development.md

theme:
  name: material
  icon:
    logo: fontawesome/solid/book
    repo: fontawesome/brands/github
  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
  features: [navigation.top, navigation.indexes, content.code.annotate, content.code.copy]

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      guess_lang: false
  - pymdownx.inlinehilite
  - pymdownx.keys:
      key_map:
        click: Click
        left-click: Left Click
        right-click: Right Click
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.saneheaders
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/griffe/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://apscheduler.readthedocs.io/en/3.x/objects.inv
          options:
            show_root_toc_entry: false
            separate_signature: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
extra:
  version:
    provider: mike