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-2025, 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
    - navigation.indexes
  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

# 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.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - md_in_html
  - attr_list
  - toc:
      permalink: true

plugins:
  - glightbox
  - search
  - mkdocs-video

nav:
  - Home: index.md
  - User Guide:
    - Overview: user-guide/overview.md
    - Installation:
      - Installation for Sim: user-guide/installation/installation-sim.md
      - Installation on Hardware: user-guide/installation/installation-hardware.md
      - Using Docker with ROSflight: user-guide/installation/using-docker-with-rosflight.md
    - Tutorials:
      - user-guide/tutorials/index.md
      - Setting up ROSflight Sim: user-guide/tutorials/setting-up-rosflight-sim.md
      - Manually flying ROSflight Sim: user-guide/tutorials/manually-flying-rosflight-sim.md
      - Running ROScopter in Sim: user-guide/tutorials/setting-up-roscopter-in-sim.md
      - Running ROSplane in Sim: user-guide/tutorials/setting-up-rosplane-in-sim.md
      - Tuning performance: user-guide/tutorials/tuning-performance-in-sim.md
      - Transitioning from Sim to Hardware: 
        - Overview: user-guide/tutorials/transitioning-from-sim-to-hardware.md
        - Xflr5: user-guide/tutorials/user-manual-xflr5.md
        - OpenVSP: user-guide/tutorials/user-manual-openvsp.md
        - ROSflight Integration: user-guide/tutorials/user-manual-ROSflight-integration.md
        - Appendix: user-guide/tutorials/user-manual-appendix.md
    - ROSflightIO: user-guide/rosflight-io.md
    - ROSflight Firmware:
      - Code Architecture: user-guide/rosflight-firmware/code-architecture.md
      - Parameter Configuration: user-guide/rosflight-firmware/parameter-configuration.md
      - Mixer: user-guide/rosflight-firmware/mixer.md
      - Autonomous Flight: user-guide/rosflight-firmware/autonomous-flight.md
    - ROSplane:
      - User Guide Overview: user-guide/rosplane/rosplane-user-overview.md
      - Controller:
        - General Controller Overview: user-guide/rosplane/controller/controller-general-overview.md
        - Controller Software Architecture: user-guide/rosplane/controller/controller-software-architecture.md
        - Controller ROS: user-guide/rosplane/controller/controller-ros.md
        - Controller State Machine: user-guide/rosplane/controller/controller-state-machine.md
        - Successive Loop Closure Controller Outline: user-guide/rosplane/controller/controller-outline.md
        - Total Energy Controller: user-guide/rosplane/controller/controller-total-energy.md
      - Estimator:
        - Estimator Overview: user-guide/rosplane/estimator/estimator-overview.md
        - Estimator ROS: user-guide/rosplane/estimator/estimator-ros.md
        - Estimator Continuous-Discrete: user-guide/rosplane/estimator/estimator-continuous-discrete.md
      - Parameter Management: user-guide/rosplane/parameter-management.md
      - Navigation: 
        - Navigation Overview: user-guide/rosplane/navigation/navigation-overview.md
        - Path Planner: user-guide/rosplane/navigation/path-planner.md
        - Path Manager: user-guide/rosplane/navigation/path-manager.md
        - Path Follower: user-guide/rosplane/navigation/path-follower.md
      - user-guide/rosplane/index.md
      - ROSplane Setup: user-guide/rosplane/rosplane-setup.md
    - ROScopter:
      - user-guide/roscopter/index.md
      - ROScopter Path Planner: user-guide/roscopter/roscopter-path-planner.md
      - ROScopter Path Manager: user-guide/roscopter/roscopter-path-manager.md
      - ROScopter Trajectory Follower: user-guide/roscopter/roscopter-trajectory-follower.md
      - ROScopter Controller: user-guide/roscopter/roscopter-controller.md
      - ROScopter Estimator: user-guide/roscopter/roscopter-estimator.md
    - ROSflight Sim:
      - user-guide/rosflight-sim/index.md
      - Simulator Architecture: user-guide/rosflight-sim/simulator-architecture.md
      - Standalone Sim: user-guide/rosflight-sim/standalone-sim.md
      - Gazebo Sim: user-guide/rosflight-sim/gazebo-sim.md
      - HoloOcean Sim: user-guide/rosflight-sim/holoocean-sim.md
    - ROSflight in Hardware:
      - Getting Started: user-guide/hardware-and-rosflight/getting-started.md
      - Hardware Setup: user-guide/hardware-and-rosflight/hardware-setup.md
      - Flight Controller Setup: user-guide/hardware-and-rosflight/flight-controller-setup.md
      - RC Configuration: user-guide/hardware-and-rosflight/rc-configuration.md
      - Pre-Flight Checks: user-guide/hardware-and-rosflight/preflight-checks.md
      - Improving Firmware Performance: user-guide/hardware-and-rosflight/improving-firmware-performance.md
    - Customizing ROSflight: user-guide/customizing-rosflight.md
  - Developer Guide:
    - Contribution Guidelines: developer-guide/contribution-guidelines.md
    - Style Guide: developer-guide/style-guide.md
    - Firmware:
      - Unit Tests: developer-guide/firmware/unit-tests.md
      - Debugging: developer-guide/firmware/debugging.md
  - Publications:
    - ROSplane: publications/rosplane.md
    - ROSflight: publications/rosflight.md