mkdocs.yml

site_name: DiffBot Differential Drive Mobile Robot
theme:
  name: material
  highlightjs: true
  custom_dir: docs/custom_theme
  features:
    - navigation.tabs
    - navigation.top
    - navigation.indexes
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

#extra_javascript:
#  - https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js
#  - custom_theme/js/config.js

site_url: https://ros-mobile-robots.com/
  
repo_url: https://github.com/ros-mobile-robots/diffbot

edit_uri: https://github.com/ros-mobile-robots/ros-mobile-robots.github.io/tree/main/docs

# Extra parameters
extra:
  asset_dir: /resources # /assets
  diffbot_repo_url: https://github.com/ros-mobile-robots/diffbot/blob/noetic-devel
  remo_repo_url: https://github.com/ros-mobile-robots/remo_description/blob/main
  disqus: ros-mobile-robots
  analytics:
    provider: google
    property: G-5Z9V7GPRX3
    
copyright: Copyright &copy; 2021 - 2021 Franz Pucher | <a href="https://www.ros-mobile-robots.com/privacy-policy/">Privacy Policy</a> | <a href="https://www.ros-mobile-robots.com/legal-notice/">Legal Notice</a>

markdown_extensions:
  - abbr
  - admonition
  - extra
  - footnotes
  - meta
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.highlight:
      linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - macros
  - mkdocs-jupyter:
      execute: False
      include_source: True
  - glightbox

nav:
  - Home: index.md
  - Getting Started:
    - Technical Requirements: technical_requirements.md
    - Components: components.md
  - Robotics Theory:
    - theory/index.md
    - Preliminaries:
      - Linear Algebra: theory/preliminaries/linear-algebra.md
      - Probability: theory/preliminaries/probability.md
      - Programming: theory/preliminaries/programming.md
    - Modeling and Control:
      - Introduction to Control Systems: theory/modeling-control/control-systems-introduction.md
      - Representations and models: theory/modeling-control/robot-representations.md
      - Modeling a Differential Drive Robot: theory/modeling-control/modeling-differential-drive-robot.md
      - Odometry: theory/modeling-control/odometry.md
    - Robot Vision:
      - Pinhole Camera Model: theory/robot-vision/pinhole-camera-model.md
      - Camera Calibration: theory/robot-vision/camera-calibration.md
      - Image Processing: theory/robot-vision/image-processing.md
      - Features and Segmentation: theory/robot-vision/features-and-segmentation.md
      - Tracking Image Features: theory/robot-vision/tracking-image-features.md
      - Combining Camera and Lidar: theory/robot-vision/combining-camera-and-lidar.md
    - Object Detection: theory/object-detection/overview.md
    - State Estimation: 
      - Recursive State Estimation: theory/state-estimation/recursive-state-estimation.md
      - Gaussian Filters (Kalman Filter): theory/state-estimation/gaussian-filters.md
      - Nonparametric Filters (Particle Filter): theory/state-estimation/nonparametric-filters.md
    - Localization:
      - Markov and Gaussian Localization: theory/localization/markov-and-gaussian-localization.md
      - Grid and Monte Carlo Localization: theory/localization/grid-and-monte-carlo-localization.md
    - Mapping:
      - Occupancy Grid Mapping: theory/mapping/occupancy-grid-mapping.md
    - Simultaneous Localization and Mapping (SLAM): 
      - SLAM Overview: theory/slam/slam-overview.md
      - Robot Moving and Sensing Notebook: theory/slam/1. Robot Moving and Sensing.ipynb
      - Omega and Xi Constraints Notebook: theory/slam/2. Omega and Xi, Constraints.ipynb
      - Landmark Detection and Tracking: theory/slam/3. Landmark Detection and Tracking.ipynb
      - EKF SLAM: theory/slam/ekf-slam.md
      - GraphSLAM: theory/slam/graphslam.md
      - FastSLAM: theory/slam/fastslam.md
      - GMapping: theory/slam/gmapping.md
    - Planning I: theory/planning1/overview.md
    - Planning II: theory/planning2/overview.md
    - Learning by Reinforcement: theory/reinforcement-learning/overview.md
    - Learning by Imitation: theory/imitation-learning/overview.md
  - Hardware and Theory:
    - Motion and Odometry: theory/motion-and-odometry.md
    - Power Supply: power-supply.md
    - Laser Range Scanner: laser-range-scanner.md
  - Processing Units:
    - Single Board Computer:
      - Raspberry Pi Setup: rpi-setup.md
      - Jetson Nano Setup: jetson-nano-setup.md
      - Git Setup: git-setup.md
      - ROS Setup: ros-setup.md
    - Microcontroller: packages/diffbot_base/scripts/teensy-mcu.md
    - Hardware Interfaces: hardware-interfaces.md
    - ROS Network Setup: ros-network-setup.md
  - Packages:
    - packages/index.md
    - Robot Package: diffbot_robot.md
    - Robot Description:
      - Robot Description: robot-description.md
      - Remo Description: packages/remo_description.md
    - Simulation: diffbot_gazebo.md
    - Control: diffbot_control.md
    - Base Hardware Interface:
      - packages/diffbot_base/index.md
      - PID Controllers: packages/diffbot_base/pid.md
      - Low-Level PID Approach: packages/diffbot_base/low-level.md
      - High-Level PID Approach: packages/diffbot_base/high-level.md
    - Messages: diffbot_msgs.md
    - Motor Driver: grove_motor_driver.md
    - Motor and Encoder: DG01D-E-motor-with-encoder.md
    - Navigation: diffbot_navigation.md
    - SLAM: diffbot_slam.md
    - Move Base Flex: diffbot_mbf.md
    - Hardware Bringup: diffbot_bringup.md
    - Rasperry Pi Camera: packages/raspicam_node.md
    - Inertial Measurement Unit:
      - Robot Localization: packages/imu/robot_localization.md
      - BNO055 Driver: packages/imu/driver-bno055.md
  - Insiders: insiders/index.md