1site_name: Bumble
2
3use_directory_urls: false
4
5nav:
6  - Introduction: index.md
7  - Getting Started: getting_started.md
8  - Development:
9    - Python Environments: development/python_environments.md
10    - Contributing: development/contributing.md
11    - Code Style: development/code_style.md
12  - Use Cases:
13    - use_cases/index.md
14    - Use Case 1: use_cases/use_case_1.md
15    - Use Case 2: use_cases/use_case_2.md
16    - Use Case 3: use_cases/use_case_3.md
17    - Use Case 4: use_cases/use_case_4.md
18    - Use Case 5: use_cases/use_case_5.md
19    - Use Case 6: use_cases/use_case_6.md
20  - Components:
21    - Controller: components/controller.md
22    - Host: components/host.md
23    - GATT: components/gatt.md
24    - Security Manager: components/security_manager.md
25  - Transports:
26    - transports/index.md
27    - Serial: transports/serial.md
28    - USB: transports/usb.md
29    - PTY: transports/pty.md
30    - UDP: transports/udp.md
31    - TCP Client: transports/tcp_client.md
32    - TCP Server: transports/tcp_server.md
33    - WebSocket Client: transports/ws_client.md
34    - WebSocket Server: transports/ws_server.md
35    - VHCI: transports/vhci.md
36    - HCI Socket: transports/hci_socket.md
37    - Android Emulator: transports/android_emulator.md
38    - File: transports/file.md
39  - Drivers:
40    - drivers/index.md
41    - Realtek: drivers/realtek.md
42  - API:
43    - Guide: api/guide.md
44    - Examples: api/examples.md
45    - Reference: api/reference.md
46  - Apps & Tools:
47    - apps_and_tools/index.md
48    - Console: apps_and_tools/console.md
49    - Bench: apps_and_tools/bench.md
50    - Speaker: apps_and_tools/speaker.md
51    - HCI Bridge: apps_and_tools/hci_bridge.md
52    - Golden Gate Bridge: apps_and_tools/gg_bridge.md
53    - Show: apps_and_tools/show.md
54    - GATT Dump: apps_and_tools/gatt_dump.md
55    - Pair: apps_and_tools/pair.md
56    - Unbond: apps_and_tools/unbond.md
57    - USB Probe: apps_and_tools/usb_probe.md
58    - Link Relay: apps_and_tools/link_relay.md
59  - Hardware:
60    - hardware/index.md
61  - Platforms:
62    - platforms/index.md
63    - macOS: platforms/macos.md
64    - Linux: platforms/linux.md
65    - Windows: platforms/windows.md
66    - Android: platforms/android.md
67    - Zephyr: platforms/zephyr.md
68  - Examples:
69    - examples/index.md
70  - Extras:
71    - extras/index.md
72    - Android Remote HCI: extras/android_remote_hci.md
73    - Android BT Bench: extras/android_bt_bench.md
74  - Hive:
75    - hive/index.md
76    - Speaker: hive/web/speaker/speaker.html
77    - Scanner: hive/web/scanner/scanner.html
78    - Heart Rate Monitor: hive/web/heart_rate_monitor/heart_rate_monitor.html
79
80copyright: Copyright 2021-2023 Google LLC
81
82theme:
83  name: 'material'
84  logo: 'images/logo.png'
85  favicon: 'images/favicon.ico'
86  custom_dir: 'theme'
87  features:
88    - navigation.indexes
89
90plugins:
91  - mkdocstrings:
92      handlers:
93        python:
94          paths: [../..]
95
96docs_dir: 'src'
97
98edit_uri: ''
99
100# Repo info
101repo_name: 'GitHub'
102repo_url: https://github.com/google/bumble
103
104# Extensions
105markdown_extensions:
106  - admonition
107  - attr_list
108  - pymdownx.details
109  - pymdownx.superfences
110  - pymdownx.emoji:
111      emoji_index: !!python/name:materialx.emoji.twemoji
112      emoji_generator: !!python/name:materialx.emoji.to_svg
113  - pymdownx.tabbed:
114      alternate_style: true
115  - codehilite:
116      guess_lang: false
117  - toc:
118      permalink: true
119