mkdocs.yml

site_name: HULKs Documentation
remote_branch: docs
theme:
  name: material
  logo: logo.svg
  features:
    - content.code.annotate
    - content.tabs.link
    - navigation.indexes
    - navigation.tabs
    - navigation.tracking
  palette:
    - media: "(prefers-color-scheme: light)"
      primary: green
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: green
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
nav:
  - Introduction: index.md
  - Setup:
      - Overview: setup/overview.md
      - Development Environment: setup/development_environment.md
      - Configure Team: setup/configure_team.md
      - NAO Image & SDK: setup/nao_image_and_sdk.md
      - NAO Setup: setup/nao_setup.md
      - Upload HULK: setup/upload.md
  - Framework:
      - Overview: framework/overview.md
      - Directory Structure: framework/directory_structure.md
      - Process Entrypoint: framework/process_entrypoint.md
      - Runtime: framework/runtime.md
      - Cyclers: framework/cyclers.md
      - Nodes: framework/nodes.md
      - Databases & Types: framework/databases_and_types.md
      - Parameters: framework/parameters.md
      - Communication: framework/communication.md
      - Hardware Interface: framework/hardware_interface.md
      - Thread Communication: framework/thread_communication.md
      - Filtering: framework/filtering.md
      - Macros: framework/macros.md
      - Path SerDe: framework/path_serde.md
      - Error Handling: framework/error_handling.md
      - Logging: framework/logging.md
  - Tooling:
      - Overview: tooling/overview.md
      - Aliveness: tooling/aliveness.md
      - Charging box:
          - Overview: tooling/charging_box/overview.md
          - Building your own: tooling/charging_box/building_your_own.md
      - Pepsi: tooling/pepsi.md
      - Twix: tooling/twix.md
      - Depp: tooling/depp.md
      - Fanta: tooling/fanta.md
      - Recording & Replay: tooling/recording_and_replay.md
      - Machine Learning: tooling/machine-learning.md
      - Behavior Simulator: tooling/behavior_simulator.md
      - Debugging with GDB/LLDB: tooling/debugging.md
  - Operating System:
      - Overview: operating_system/overview.md
      - Partitioning: operating_system/partitioning.md
      - Home Directory: operating_system/home_directory.md
      - Linux: operating_system/linux.md
      - WiFi: operating_system/wifi.md
      - HULA: operating_system/hula.md
  - Robotics:
      - Overview: robotics/overview.md
      - Perception:
          - Vision: robotics/perception/vision.md
          - Audio: robotics/perception/audio.md
          - Filters: robotics/perception/filters.md
          - SPL Network: robotics/perception/spl_network.md
      - Behavior: robotics/behavior/overview.md
      - Motion:
          - Overview: robotics/motion/overview.md
          - Step planning: robotics/motion/step_planning.md
          - Walking: robotics/motion/walking.md
          - Kicking: robotics/motion/kicking.md
          - Motion Files: robotics/motion/motion_files.md
      - Miscellaneous:
          - Create URDF and PROTO for NAOv6: robotics/miscellaneous/create_urdf.md
  - Workflow:
      - Overview: workflow/overview.md
      - Getting Started: workflow/getting_started.md
      - Development: workflow/development.md
      - Competition: workflow/competition.md
      - Engineering: workflow/engineering.md
      - GitHub Webhooks: workflow/github_webhooks.md
      - Leadership: workflow/leadership.md
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.blocks.caption

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js