mkdocs.yml

site_name: ROSflight
site_description: 'A lean, open-source autopilot system built by researchers, for researchers'
site_url: http://rosflight.org
site_author: 'James Jackson, Daniel Koch, Ian Reid, Brandon Sutherland, Jacob Moore'
copyright: 'Copyright © 2019-2024, James Jackson, Daniel Koch, Ian Reid, Brandon Sutherland, Jacob Moore, BYU MAGICC Lab'

edit_uri: 'https://github.com/rosflight/rosflight_docs/edit/main/docs/'

theme:
  name: material
  custom_dir: overrides
  language: en
  features:
    - content.action.edit
    - navigation.tabs
  palette:
    primary: blue grey
    accent: red
  favicon: assets/favicon.ico
  logo: assets/logo.png
  analytics:
    gtag: UA-96018590-2

extra:
  version:
    provider: mike

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

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
  - User Guide:
    - Overview: user-guide/overview.md
    - ROSflight:
      - Getting Started: user-guide/getting-started.md
      - Hardware Setup: user-guide/hardware-setup.md
      - Flight Controller Setup: user-guide/flight-controller-setup.md
      - RC Configuration: user-guide/rc-configuration.md
      - ROS2 Setup: user-guide/ros2-setup.md
      - Parameter Configuration: user-guide/parameter-configuration.md
      - Pre-Flight Checks: user-guide/preflight-checks.md
      - Improving Firmware Performance: user-guide/improving-firmware-performance.md
      - Autonomous Flight: user-guide/autonomous-flight.md
      - Running Gazebo Simulation: user-guide/running-gazebo-simulation.md
    - ROSplane:
      - ROSplane Overview: user-guide/rosplane-overview.md
      - ROSplane Setup: user-guide/rosplane-setup.md
    - ROScopter:
      - ROScopter Overview: user-guide/roscopter-overview.md
      - ROScopter Setup: user-guide/roscopter-setup.md
  - Developer Guide:
    - Contribution Guidelines: developer-guide/contribution-guidelines.md
    - Style Guide: developer-guide/style-guide.md
    - Firmware:
      - Code Architecture: developer-guide/firmware/code-architecture.md
      - Building and Flashing: developer-guide/firmware/building-and-flashing.md
      - Unit Tests: developer-guide/firmware/unit-tests.md
      - Debugging: developer-guide/firmware/debugging.md
    - ROSplane:
      - Developer Guide Overview: developer-guide/rosplane/rosplane-dev-overview.md
      - Controller:
        - General Controller Overview: developer-guide/rosplane/controller/controller-general-overview.md
        - Controller Software Architecture: developer-guide/rosplane/controller/controller-software-architecture.md
        - Controller Base: developer-guide/rosplane/controller/controller-base.md
        - Controller State Machine: developer-guide/rosplane/controller/controller-state-machine.md
        - Successive Loop Closure Controller Outline: developer-guide/rosplane/controller/controller-outline.md
        - Total Energy Controller: developer-guide/rosplane/controller/controller-total-energy.md
      - Estimator:
        - Estimator Overview: developer-guide/rosplane/estimator/estimator-overview.md
        - Estimator Base: developer-guide/rosplane/estimator/estimator-base.md
        - Estimator Example: developer-guide/rosplane/estimator/estimator-example.md
      - Parameter Management: developer-guide/rosplane/parameter-management.md
      - Navigation: 
        - Navigation Overview: developer-guide/rosplane/navigation/navigation-overview.md
        - Path Planner: developer-guide/rosplane/navigation/path-planner.md
        - Path Manager: developer-guide/rosplane/navigation/path-manager.md
        - Path Follower: developer-guide/rosplane/navigation/path-follower.md
#    - ROS Packages:
#    - ROSplane:
#    - ROScopter: