create3_docs/mkdocs.yml at main · Rebecca-iRobot/create3_docs · GitHub

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
site_name: Create® 3 Docs
site_description: 'Documentation for the iRobot® Create® 3 robot'
site_author: 'iRobot'
#site_url: http://edu.irobot.com/create3/

repo_name: 'iRobotEducation/create3_docs'
repo_url: 'https://github.com/iRobotEducation/create3_docs'

edit_uri: 'edit/main/docs/'

docs_dir: docs/

theme:
  name: material
  custom_dir: theme_overrides
  logo: assets/irobot_symbol_white.png
  favicon: assets/irobot_symbol_green.png

extra_css:
  - stylesheets/irobot-palette.css

markdown_extensions:
  - admonition
  - footnotes

nav:
    - Home: index.md
    - Hardware:
      - Overview: hw/overview.md
      - Mechanical: hw/mechanical.md
      - Electrical: hw/electrical.md
      - Hookup Examples: hw/hookup.md
    - Setup:
      - Connect to Wi-Fi: setup/provision.md
      - Multi-Robot Setup: setup/multi-robot.md
      - ROS 2 on an NVIDIA Jetson: setup/jetson.md
      - ROS 2 on a Pi 4: setup/pi4.md
    - APIs:
      - ROS 2 Interface: api/ros2.md
      - Docking: api/docking.md
      - Drive Goals: api/drive-goals.md
      - Hazards: api/hazards.md
      - Odometry: api/odometry.md
      - Reflexes: api/reflexes.md
      - Safety: api/safety.md
      - User Interface: api/ui.md
    - Simulator:
      - Using the Simulator: sim/setup.md
    - Software Examples:
      - Overview: examples/overview.md
      - Driving via CLI: examples/driving-cli.md
    - Software Releases:
      - Overview: releases/overview.md
      - G.1.1: releases/g_1_1.md