lovensepy/mkdocs.yml at main · koval01/lovensepy · 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
site_name: LovensePy
site_description: Python client for the Lovense API
site_url: https://lovensepy.koval-dev.org/
repo_url: https://github.com/koval01/lovensepy
repo_name: lovensepy
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

copyright: Copyright &copy; LovensePy contributors &mdash; <a href="https://github.com/koval01/lovensepy/blob/main/LICENSE">Apache License 2.0</a>

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.path
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ru
          name: Русский
          build: true
          site_description: Python-клиент для API Lovense
          nav_translations:
            Home: Главная
            Changelog: История изменений
            Installation: Установка
            Connection methods: Способы подключения
            Direct BLE: Прямой BLE
            Tutorials: Руководства
            LAN & BLE hub: Хаб LAN и BLE
            Server + QR: Сервер и QR
            Socket API: Socket API
            Toy Events: События игрушек
            Home Assistant MQTT: Home Assistant MQTT
            FastAPI LAN REST: FastAPI LAN REST
            API Reference: Справочник API
            Appendix: Приложение
  - search:
      lang:
        - en
        - ru

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite

nav:
  - Home: index.md
  - Changelog: changelog.md
  - Installation: installation.md
  - Connection methods: connection-methods.md
  - Direct BLE: direct-ble.md
  - Tutorials:
      - LAN & BLE hub: tutorials/lan.md
      - Server + QR: tutorials/server-qr.md
      - Socket API: tutorials/socket.md
      - Toy Events: tutorials/toy-events.md
      - Home Assistant MQTT: tutorials/home-assistant-mqtt.md
      - FastAPI LAN REST: tutorials/fastapi-lan-rest.md
  - API Reference: api-reference.md
  - Appendix: appendix.md

extra:
  generator: false