-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
85 lines (81 loc) · 2.69 KB
/
mkdocs.yml
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
site_name: Blueye SDK
repo_url: "https://github.com/BluEye-Robotics/blueye.sdk"
repo_name: ""
plugins:
- search
- macros:
module_name: doc_utils
markdown_extensions:
- admonition
- pymdownx.arithmatex
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
theme:
name: material
favicon: "media/blueye_b.svg"
logo: "media/blueye_sdk_logo_darkblue.svg"
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: white
accent: blue
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: black
accent: blue
custom_dir: "docs/mkdocs_templates"
features:
- content.tabs.link
extra:
version:
provider: mike
nav:
- "About the Blueye Drones": "index.md"
- "Quick Start": "quick_start.md"
- Movement:
- "Control from the CLI": "movement/from-the-CLI.md"
- "Control with a gamepad": "movement/with-a-gamepad.md"
- Video:
- "GStreamer for video streaming": "video/gstreamer-for-video-streaming.md"
- "Downloading videos and images": "video/downloading.md"
- Logs:
- "Listing and downloading log files": "logs/listing-and-downloading.md"
- "Plotting log files": "logs/plotting.md"
- "Runtime logs": "logs/runtime-logs.md"
- "Legacy log file format": "logs/legacy-log-file-format.md"
- "Configure drone parameters": "configuration.md"
- "Subscribing to a telemetry message": "telemetry-callback.md"
- "Peripherals": "peripherals.md"
- "Visualizing with Foxglove": "foxglove-bridge.md"
- "Forwarding positioning to NMEA": "nmea-publisher.md"
- "Updating from v1 to v2": "migrating-to-v2.md"
- "Protobuf protocol": "protobuf-protocol.md"
- "HTTP API": "http-api.html"
- Reference:
- blueye.sdk.battery: "reference/blueye/sdk/battery.md"
- blueye.sdk.camera: "reference/blueye/sdk/camera.md"
- blueye.sdk.connection: "reference/blueye/sdk/connection.md"
- blueye.sdk.constants: "reference/blueye/sdk/constants.md"
- blueye.sdk.drone: "reference/blueye/sdk/drone.md"
- blueye.sdk.guestport: "reference/blueye/sdk/guestport.md"
- blueye.sdk.logs: "reference/blueye/sdk/logs.md"
- blueye.sdk.motion: "reference/blueye/sdk/motion.md"
- blueye.sdk.utils: "reference/blueye/sdk/utils.md"