| site_name: Bumble | |
| use_directory_urls: false | |
| nav: | |
| - Introduction: index.md | |
| - Getting Started: getting_started.md | |
| - Development: | |
| - Python Environments: development/python_environments.md | |
| - Contributing: development/contributing.md | |
| - Code Style: development/code_style.md | |
| - Use Cases: | |
| - use_cases/index.md | |
| - Use Case 1: use_cases/use_case_1.md | |
| - Use Case 2: use_cases/use_case_2.md | |
| - Use Case 3: use_cases/use_case_3.md | |
| - Use Case 4: use_cases/use_case_4.md | |
| - Use Case 5: use_cases/use_case_5.md | |
| - Use Case 6: use_cases/use_case_6.md | |
| - Components: | |
| - Controller: components/controller.md | |
| - Host: components/host.md | |
| - GATT: components/gatt.md | |
| - Security Manager: components/security_manager.md | |
| - Transports: | |
| - transports/index.md | |
| - Serial: transports/serial.md | |
| - USB: transports/usb.md | |
| - PTY: transports/pty.md | |
| - UDP: transports/udp.md | |
| - TCP Client: transports/tcp_client.md | |
| - TCP Server: transports/tcp_server.md | |
| - WebSocket Client: transports/ws_client.md | |
| - WebSocket Server: transports/ws_server.md | |
| - VHCI: transports/vhci.md | |
| - HCI Socket: transports/hci_socket.md | |
| - Android Emulator: transports/android_emulator.md | |
| - File: transports/file.md | |
| - Drivers: | |
| - drivers/index.md | |
| - Realtek: drivers/realtek.md | |
| - Intel: drivers/intel.md | |
| - API: | |
| - Guide: api/guide.md | |
| - Examples: api/examples.md | |
| - Reference: api/reference.md | |
| - Apps & Tools: | |
| - apps_and_tools/index.md | |
| - Auracast: apps_and_tools/auracast.md | |
| - Console: apps_and_tools/console.md | |
| - Bench: apps_and_tools/bench.md | |
| - Speaker: apps_and_tools/speaker.md | |
| - HCI Bridge: apps_and_tools/hci_bridge.md | |
| - Golden Gate Bridge: apps_and_tools/gg_bridge.md | |
| - Show: apps_and_tools/show.md | |
| - GATT Dump: apps_and_tools/gatt_dump.md | |
| - Pair: apps_and_tools/pair.md | |
| - Unbond: apps_and_tools/unbond.md | |
| - USB Probe: apps_and_tools/usb_probe.md | |
| - Hardware: | |
| - hardware/index.md | |
| - Platforms: | |
| - platforms/index.md | |
| - macOS: platforms/macos.md | |
| - Linux: platforms/linux.md | |
| - Windows: platforms/windows.md | |
| - Android: platforms/android.md | |
| - Zephyr: platforms/zephyr.md | |
| - Examples: | |
| - examples/index.md | |
| - Extras: | |
| - extras/index.md | |
| - Android Remote HCI: extras/android_remote_hci.md | |
| - Android BT Bench: extras/android_bt_bench.md | |
| - Hive: | |
| - hive/index.md | |
| - Speaker: hive/web/speaker/speaker.html | |
| - Scanner: hive/web/scanner/scanner.html | |
| - Heart Rate Monitor: hive/web/heart_rate_monitor/heart_rate_monitor.html | |
| copyright: Copyright 2021-2023 Google LLC | |
| theme: | |
| name: 'material' | |
| logo: 'images/logo.png' | |
| favicon: 'images/favicon.ico' | |
| custom_dir: 'theme' | |
| features: | |
| - navigation.indexes | |
| plugins: | |
| - mkdocstrings: | |
| handlers: | |
| python: | |
| paths: [../..] | |
| docs_dir: 'src' | |
| edit_uri: '' | |
| # Repo info | |
| repo_name: 'GitHub' | |
| repo_url: https://github.com/google/bumble | |
| # Extensions | |
| markdown_extensions: | |
| - admonition | |
| - attr_list | |
| - pymdownx.details | |
| - pymdownx.superfences | |
| - pymdownx.emoji: | |
| emoji_index: !!python/name:material.extensions.emoji.twemoji | |
| emoji_generator: !!python/name:material.extensions.emoji.to_svg | |
| - pymdownx.tabbed: | |
| alternate_style: true | |
| - codehilite: | |
| guess_lang: false | |
| - toc: | |
| permalink: true |