taskbadger-docs/mkdocs.yml at main · taskbadger/taskbadger-docs · 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
site_name: Task Badger Documentation
site_url: https://docs.taskbadger.net
repo_url: https://github.com/taskbadger/taskbadger-docs/
theme:
  name: material
  logo: assets/logo_white.png
  favicon: assets/favicon.ico
  features:
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - admonition
  - tables
  - def_list
  - attr_list
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
  - assets/css/extra.css
extra:
  analytics:
    provider: google
    property: G-018PZFQ3EE
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/@task_badger
    - icon: fontawesome/brands/github
      link: https://github.com/taskbadger
copyright: Copyright &copy; 2020 - 2025 Simon Kelly
nav:
  - Docs:
    - 'index.md'
    - 'quick.md'
    - 'basics.md'
    - 'cli.md'
    - 'monitors.md'
    - 'data_model.md'
    - 'api.md'
    - 'integrations.md'
  - 'Python SDK':
    - 'Basic Usage': 'python.md'
    - 'Function Decorator': 'python-decorator.md'
    - 'Celery Integration': 'python-celery.md'
  - 'Changelog':
    - 'changelog.md'

plugins:
- mkdocstrings:
    handlers:
      python:
        inventories:
          - https://docs.python-requests.org/en/master/objects.inv
        paths:
          - !ENV [TB_PYTHON_SRC, '../taskbadger-python']
        options:
          show_root_heading: true
          show_source: False
          show_signature_annotations: True
          separate_signature: True
          members_order: source
          heading_level: 3
          line_length: 80
- search:
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
watch:
- !ENV [TB_PYTHON_SRC, '../taskbadger-python']