• 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  - Use Cases:
11    - Overview: use_cases/index.md
12    - Use Case 1: use_cases/use_case_1.md
13    - Use Case 2: use_cases/use_case_2.md
14    - Use Case 3: use_cases/use_case_3.md
15    - Use Case 4: use_cases/use_case_4.md
16    - Use Case 5: use_cases/use_case_5.md
17    - Use Case 6: use_cases/use_case_6.md
18  - Components:
19    - Controller: components/controller.md
20    - Host: components/host.md
21    - GATT: components/gatt.md
22    - Security Manager: components/security_manager.md
23  - Transports:
24    - Overview: transports/index.md
25    - Serial: transports/serial.md
26    - USB: transports/usb.md
27    - PTY: transports/pty.md
28    - UDP: transports/udp.md
29    - TCP Client: transports/tcp_client.md
30    - TCP Server: transports/tcp_server.md
31    - WebSocket Client: transports/ws_client.md
32    - WebSocket Server: transports/ws_server.md
33    - VHCI: transports/vhci.md
34    - HCI Socket: transports/hci_socket.md
35    - Android Emulator: transports/android_emulator.md
36    - File: transports/file.md
37  - API:
38    - Guide: api/guide.md
39    - Examples: api/examples.md
40    - Reference: api/reference.md
41  - Apps & Tools:
42    - Overview: apps_and_tools/index.md
43    - Console: apps_and_tools/console.md
44    - Link Relay: apps_and_tools/link_relay.md
45    - HCI Bridge: apps_and_tools/hci_bridge.md
46    - Golden Gate Bridge: apps_and_tools/gg_bridge.md
47    - Show: apps_and_tools/show.md
48  - Hardware:
49    - Overview: hardware/index.md
50  - Platforms:
51    - Overview: platforms/index.md
52    - macOS: platforms/macos.md
53    - Linux: platforms/linux.md
54    - Windows: platforms/windows.md
55    - Android: platforms/android.md
56  - Examples:
57    - Overview: examples/index.md
58
59copyright: Copyright 2021-2022 Google LLC
60
61theme:
62  name: 'material'
63  logo: 'images/logo.png'
64  favicon: 'images/favicon.ico'
65  custom_dir: 'theme'
66
67plugins:
68  - mkdocstrings:
69      handlers:
70        python:
71          paths: [../..]
72
73docs_dir: 'src'
74
75edit_uri: ''
76
77# Repo info
78repo_name: 'GitHub'
79repo_url: https://github.com/google/bumble
80
81# Extensions
82markdown_extensions:
83  - admonition
84  - attr_list
85  - pymdownx.details
86  - pymdownx.superfences
87  - pymdownx.emoji:
88      emoji_index: !!python/name:materialx.emoji.twemoji
89      emoji_generator: !!python/name:materialx.emoji.to_svg
90  - codehilite:
91      guess_lang: false
92  - toc:
93      permalink: true
94