stretch_tutorials/mkdocs_rt.yml at master · hello-robot/stretch_tutorials · 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
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
site_name: ros2
site_url: https://docs.hello-robot.com/stretch_tutorials
site_description: "Hello Robot Stretch Tutorials"
copyright: 'Copyright &copy; 2022 Hello Robot Inc'
site_author: Hello Robot Inc
use_directory_urls: True
docs_dir: ros2
site_dir: ../site

theme:
 name: material
 #font: Arial
 palette:
  - scheme: default
    primary: hello-robot-light
    toggle:
      icon: material/lightbulb-outline
      name: Switch to dark mode
  - scheme: slate
    primary: hello-robot-dark
    toggle:
      icon: material/lightbulb
      name: Switch to light mode
 logo: images/hello_robot_logo_light.png
 favicon: images/hello_robot_favicon.png
 features:
  - navigation.instant

extra_css:
  - ./extra.css

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.keys
  - admonition
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - same-dir
#  - simple:
#      merge_docs_dir: true
#      include_extensions: [".css", ".png"]
#      include_folders: ['../hello_helpers']
  - mike:
      # these fields are all optional; the defaults are as below...
      version_selector: true   # set to false to leave out the version selector
      css_dir: css             # the directory to put the version selector's CSS
      javascript_dir: js       # the directory to put the version selector's JS
      canonical_version: null  # the version for <link rel="canonical">; `null`
      # uses the version specified via `mike deploy`
  - search
  - tags
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          selection:
            docstring_style: numpy
          rendering:
            show_root_heading: true
            show_source: false
            members_order: source
            heading_level: 3
            show_if_no_docstring: true

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: material/home
      link: https://hello-robot.com
    - icon: material/twitter
      link: https://twitter.com/HelloRobotInc
    - icon: material/github
      link: https://github.com/hello-robot
    - icon: material/linkedin
      link: https://linkedin.com/company/hello-robot-inc


nav:
  - Getting Started: ./getting_started.md
  - ROS 2 Basics:
    - Creating Packages & Nodes: ./writing_nodes.md
    - Introduction to ROS 2 Client (rclpy): ./intro_to_ros2.md
    - Introduction to HelloNode: ./intro_to_hellonode.md
  - Simulation Tutorial: ./stretch_simulation.md
  - Teleoperation: ./teleoperating_stretch.md
  - RViz Tutorial: ./rviz_basics.md
  - Follow Joint Trajectory & Joint States: ./follow_joint_trajectory.md
  - Motion Commands via hello_utils: ./jogging.md
  - Robot Driver: ./robot_drivers.md
  - Twist Control: ./twist_control.md
  - Sensors Tutorial: ./sensors_tutorial.md
  - Nav Stack Tutorial:
    - Overview: ./navigation_overview.md
    - Nav2 Basics: ./navigation_stack.md
    - Nav2 Simple Commander: ./navigation_simple_commander.md
  - Deep Perception: ./deep_perception.md
  - ArUco Markers: ./aruco_marker_detection.md
  - Offloading Computation Tutorial: ./remote_compute.md
  - Autonomy Demos:
    - Hello World: ./demo_hello_world.md
    - Grasp Object: ./demo_grasp_object.md
    - Handover Object: ./demo_handover_object.md
    - Open Drawer: ./demo_open_drawer.md
    - Surface Cleaning: ./demo_surface_cleaning.md
  - FUNMAP Tutorial: ./funmap_tutorial.md
  - Examples:
    - Voice Teleop: ./voice_teleop.md
    - Speech to Text: ./speech_to_text.md
    - Lidar Based Sensing: ./lidar_filtering.md
    - Custom RViz Marker: ./rviz_markers.md
    - Effort Value Plotting: ./joint_effort_plotting.md
    - Tf2 Listener and Broadcaster: ./tf2_transforms.md
    - Realsense Camera: ./realsense_camera.md
    - Align to ArUco Tutorial: ./align_to_aruco.md
    - ArUco Locator: ./aruco_marker_detection#aruco-locator-example
    - Joint States: ./joint_states.md
    - Collision Avoidance: ./collision_avoidance.md
    - Obstacle Avoidance: ./obstacle_avoider.md