stretch_tutorials/mkdocs.yml

site_name: tutorials
site_url: https://docs.hello-robot.com/stretch_tutorials
site_description: "Hello Robot Stretch Tutorials"
copyright: 'Copyright © 2022 Hello Robot Inc'
site_author: Hello Robot Inc
use_directory_urls: True
docs_dir: .
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:
  - Overview: ./README.md

  - Developing with Stretch:
    - The Basics: ./developing/basics.md
    - Networking Guide: ./developing/networking.md
    - Command Line Tools: ./developing/cli.md
    - Using Python with Stretch: ./developing/python.md

  - Python Tutorials:
    - ./python/sensors.md

  - ROS 2 Tutorials:
    - Getting Started: ./ros2/getting_started.md
    - Robot Drivers: ./ros2/robot_drivers.md
    - Writing Nodes: ./ros2/writing_nodes.md
    - Navigation with Nav2:
      - Overview: ./ros2/navigation_overview.md
      - Nav2 Basics: ./ros2/navigation_stack.md
      - Nav2 Simple Commander: ./ros2/navigation_simple_commander.md
    - Manipulation with MoveIt2:
      - MoveIt Basics: ./ros2/moveit_basics.md
      - MoveIt with RViz: ./ros2/moveit_rviz_demo.md
      - MoveGroup C++ API: ./ros2/moveit_movegroup_demo.md
    - FUNMAP:
      - Mapping: ./ros2/writing_nodes.md
      - Navigation: ./ros2/writing_nodes.md
      - Manipulation: ./ros2/writing_nodes.md
    - Perception: ./ros2/perception.md
    - Examples:
      - Filter Laser Scans: ./ros2/example_2.md
      - Collision Avoidance: ./ros2/example_3.md
      - Rviz Markers: ./ros2/example_4.md
      - Offloading Computation: ./ros2/remote_compute.md
      - ArUco Locator: ./ros2/example_12.md
      - Voice Teleop: ./ros2/example_9.md
      - Playing Audio: ./ros2/example_9.md
      - Rosbags & MCAPs: ./ros2/example_9.md