mkdocs.yml

site_name: MAGICC Wiki
site_description: 'Tutorials and guides for the MAGICC lab'
site_url: https://byu-magicc.github.io/wiki
site_author: 'MAGICC lab members'

edit_uri: 'https://github.com/byu-magicc/wiki/edit/main/docs/'

theme:
  name: material
  features:
    - content.action.edit
    - navigation.tabs
  palette:
    primary: custom
    accent: custom
  favicon: assets/favicon-16x16.png
  logo: assets/logo.svg

extra_javascript:
    - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - codehilite:
      linenums: false
      guess_lang: false
  - footnotes
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Safety: safety.md
  - ROS Tutorials:
      - "Lesson 1: Introduction to ROS": ros_tutorials/intro.md
      - "Lesson 2: Starting Nodes": ros_tutorials/starting_nodes.md
      - "Lesson 3: Getting Info About Nodes": ros_tutorials/node_info.md
      - "Assignment 1: Turtlesim": ros_tutorials/assignments/turtlesim_assignment.md
      - "Lesson 4: The ROS Filesystem": ros_tutorials/filesystem.md
      - "Lesson 5: Launch Files": ros_tutorials/launch_files.md
      - "Assignment 2: Creating Your Own Launch File": ros_tutorials/assignments/creating_launch_file.md
      - "Lesson 6: rostopic": ros_tutorials/rostopic.md
      - "Assignment 3: Nodes, Topics, and Messages": ros_tutorials/assignments/nodes_topics_and_messages.md
      - "Lesson 7: Topic Remapping": ros_tutorials/topic_remapping.md
      - "Lesson 8: Parameters": ros_tutorials/parameters.md
      - "Lesson 9: Additional Launch File Syntax": ros_tutorials/adv_launch_file.md
      - "Assignment 4: Advanced Launch File": ros_tutorials/assignments/launch_file_advanced.md
      - "Lesson 10: Creating Nodes": ros_tutorials/creating_nodes.md
      - "Lesson 11: Packages": ros_tutorials/packages.md
      - "Assignment 5: Editing Teleop Twist Joy Node": ros_tutorials/assignments/edit_node.md
      - "Lesson 12a: Nodes Based on Classes (C++)": ros_tutorials/c++_node_class.md
      - "Lesson 12b: Nodes Based on Classes (Python)": ros_tutorials/python_node_class.md
      - "Assignment 6: Drawing a Star": ros_tutorials/assignments/draw_a_star.md
      - "Assignment 7: Display/Publish Fuel Remaining": ros_tutorials/assignments/fuel.md
      - "Assignment 8: Stop Turtlesim When Fuel Runs Out": ros_tutorials/assignments/out_of_fuel.md
  - Gazebo Tutorials:
      - "Lesson 0: Overview": gazebo_tutorials/overview.md
      - "Lesson 1: Make a Robot": gazebo_tutorials/make_a_robot.md
      - "Lesson 2: Adding Plugins": gazebo_tutorials/adding_plugins.md
      - "Assignment 1: Make a Multirotor": gazebo_tutorials/assignments/make_a_multirotor.md
      - "Assignment 2: Make a Fixed Wing MAV": gazebo_tutorials/assignments/make_a_fixed_wing_mav.md
      - "Lesson 3: Interfacing with Gazebo": gazebo_tutorials/interfacing_with_gazebo.md
      - "Assignment 3: Flying Your MAV": gazebo_tutorials/assignments/flying_your_mav.md
      - "Lesson 4: Make a World": gazebo_tutorials/make_a_world.md
      - "Assignment 4: Make Your Own World": gazebo_tutorials/assignments/make_your_own_world.md
      - "Lesson 5: Adding an Image to the Ground Plane": gazebo_tutorials/adding_an_image_to_the_ground_plane.md
  - Control Tutorials:
      - "Lesson 0: Overview": control_tutorials/overview.md
      - "Lesson 1: P Controller": control_tutorials/p_controller.md
      - "Assignment 0: P Controller with TurtleSim": control_tutorials/assignments/p_turtle.md
      - "Lesson 2: PD Controller": control_tutorials/pd_controller.md
      - "Assignment 1: PD Controller with TurtleSim": control_tutorials/assignments/pd_turtle.md
      - "Lesson 3: PID Controller": control_tutorials/pid_controller.md
      - "Assignment 2: PID Controller with TurtleSim": control_tutorials/assignments/pid_turtle.md
  - Hardware Guides:
      - Pixhawk: computers/pixhawk.md
      - NVIDIA Jetson TX2: computers/jetson.md
      - Raspberry Pi Zero W: hw_guides/rospberry_pi_zero.md
      - CUDA and GPGPUs: hw_guides/gpu.md
      - Ubiquiti: hw_guides/ubiquiti.md
      - "RTK GPS: ZED-F9P": hw_guides/ublox_f9p.md
      - "RTK GPS: C94-M8P": hw_guides/c94_m8p.md
      - ASUS Xtion Pro Live: hw_guides/asus_xtion_pro_live.md
      - Intel RealSense D4xx: hw_guides/intel_rs_d400.md
      - Lithium-Polymer Batteries (Li-Po): hw_guides/lipo_batts.md
      - Battery Charger Guide: hw_guides/charging_lipo_batts.md
      - Designing a Propulsion System: hw_guides/design_propulsion_system.md
  - Software Guides:
      - Intro to Ceres Solver: sw_guides/ceres_solver.md
      - Installing CUDA: sw_guides/install_cuda.md
      - OpenCV with CUDA: sw_guides/opencv.md
      - Python Know-how: sw_guides/python.md
      - Mocap Room Tutorial: sw_guides/mocap_room_tutorial.md
      - UBLOX_read Documentation: sw_guides/ublox_read.md
      - Airsim Quickstart Guide: sw_guides/airsim_quickstart.md
      - Airsim Settings: sw_guides/airsim_settings.md
      - VTOL AirSim Quickstart Guide: sw_guides/vtol_airsim_qs_guide.md
  - Administration:
      - New Lab-member Tips: administration/new_member_tips.md
      - Conference Room Schedule: administration/conference_room_schedule.md
  - Misc:
      - Startup Scripts with systemd: computers/systemd.md
      - Headless vs Graphical Linux: computers/headless.md
      - CAEDM Integration: misc/caedm_integration.md
      - Debugging ROS Nodes: misc/debugging_ros_nodes.md
      - Environment Setup: misc/env_setup.md
      - Qt Creator: misc/qt_creator.md
      - ROS Command Cheat Sheet: misc/ros_command_cheat_sheet.md
      - Setting Up ssh: misc/setting_up_ssh.md
      - Syncing Time: misc/syncing_time.md
      - Using Git: misc/using_git.md
      - Using Vim: misc/using_vim.md
      - VPN Setup: misc/vpn_setup.md