• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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    - Overview: 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    - Overview: 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  - API:
40    - Guide: api/guide.md
41    - Examples: api/examples.md
42    - Reference: api/reference.md
43  - Apps & Tools:
44    - Overview: apps_and_tools/index.md
45    - Console: apps_and_tools/console.md
46    - Bench: apps_and_tools/bench.md
47    - HCI Bridge: apps_and_tools/hci_bridge.md
48    - Golden Gate Bridge: apps_and_tools/gg_bridge.md
49    - Show: apps_and_tools/show.md
50    - GATT Dump: apps_and_tools/gatt_dump.md
51    - Pair: apps_and_tools/pair.md
52    - Unbond: apps_and_tools/unbond.md
53    - USB Probe: apps_and_tools/usb_probe.md
54    - Link Relay: apps_and_tools/link_relay.md
55  - Hardware:
56    - Overview: hardware/index.md
57  - Platforms:
58    - Overview: platforms/index.md
59    - macOS: platforms/macos.md
60    - Linux: platforms/linux.md
61    - Windows: platforms/windows.md
62    - Android: platforms/android.md
63  - Examples:
64    - Overview: examples/index.md
65
66copyright: Copyright 2021-2023 Google LLC
67
68theme:
69  name: 'material'
70  logo: 'images/logo.png'
71  favicon: 'images/favicon.ico'
72  custom_dir: 'theme'
73
74plugins:
75  - mkdocstrings:
76      handlers:
77        python:
78          paths: [../..]
79
80docs_dir: 'src'
81
82edit_uri: ''
83
84# Repo info
85repo_name: 'GitHub'
86repo_url: https://github.com/google/bumble
87
88# Extensions
89markdown_extensions:
90  - admonition
91  - attr_list
92  - pymdownx.details
93  - pymdownx.superfences
94  - pymdownx.emoji:
95      emoji_index: !!python/name:materialx.emoji.twemoji
96      emoji_generator: !!python/name:materialx.emoji.to_svg
97  - codehilite:
98      guess_lang: false
99  - toc:
100      permalink: true
101