ucapi-framework/mkdocs.yml at main · SPLBendrix/ucapi-framework · 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
site_name: UCAPI Framework
site_description: A framework for building Unfolded Circle Remote integrations
site_author: Jack Powell
site_url: https://jackjpowell.github.io/ucapi-framework/

repo_name: JackJPowell/ucapi-framework
repo_url: https://github.com/JackJPowell/ucapi-framework

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_category_heading: true
            show_bases: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            merge_init_into_class: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - Setup Flow: guide/setup-flow.md
      - Device Patterns: guide/device-patterns.md
      - Configuration Management: guide/configuration.md
      - Discovery: guide/discovery.md
      - Driver Integration: guide/driver.md
      - Advanced Entity Patterns: guide/advanced-entity-patterns.md
  - API Reference:
      - Driver: api/driver.md
      - Device: api/device.md
      - Setup Flow: api/setup.md
      - Configuration: api/config.md
      - Discovery: api/discovery.md
  - Upgrade Guides:
      - Upgrading to 1.6.0: upgrade-to-1.6.0.md
  - Migration Guide: migration-guide.md
  - Contributing: contributing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/JackJPowell
    - icon: fontawesome/brands/discord
      link: https://discord.gg/zGVYf58