mkdocs.yml

site_name: PiTrac Documentation
site_description: >-
  Open-source DIY golf launch monitor built with Raspberry Pi.
  Ball speed, launch angles, spin rates, and simulator integration.
site_url: https://docs.pitrac.org/
repo_url: https://github.com/PiTracLM/PiTrac
repo_name: PiTracLM/PiTrac
edit_uri_template: 'https://github.com/PiTracLM/Docs/edit/main/docs/{path}'

copyright: Copyright © 2024-2026 PiTrac Community

strict: true

theme:
  name: material
  language: en
  custom_dir: overrides
  logo: assets/images/logos/PiTrac.svg
  favicon: assets/images/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - privacy
  - optimize
  - social:
      cards_layout: brand
  - glightbox
  - git-revision-date-localized:
      enable_creation_date: true
  - redirects:
      redirect_maps: {}
  - print-site

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  analytics:
    provider: google
    property: G-XWPC40V035
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PiTracLM/PiTrac
      name: PiTrac on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/j9YWCMFVHN
      name: PiTrac Discord
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@PiTrac
      name: PiTrac YouTube

extra_javascript:
  - assets/js/viewstl/stl_viewer.min.js
  - assets/js/stl-modal.js

extra_css:
  - stylesheets/extra.css

watch:
  - includes

nav:
  - Home: index.md
  - Build Guide:
    - build-guide/index.md
    - What is PiTrac?: build-guide/what-is-pitrac.md
    - Express Path: build-guide/express-path.md
  - Hardware:
    - hardware/index.md
    - Parts List: hardware/parts-list.md
    - PCB Assembly: hardware/pcb-assembly.md
    - V3 Enclosure:
      - hardware/v3-enclosure/index.md
      - 3D Printing: hardware/v3-enclosure/3d-printing.md
      - Assembly:
        - hardware/v3-enclosure/assembly/index.md
        - Eyeball Sub-Assemblies: hardware/v3-enclosure/assembly/eyeballs.md
        - Stack Modules: hardware/v3-enclosure/assembly/stack-modules.md
        - Electronics: hardware/v3-enclosure/assembly/electronics.md
        - Final Assembly: hardware/v3-enclosure/assembly/installation.md
    - Cameras:
      - hardware/cameras/index.md
      - Distortion Correction: hardware/cameras/distortion-correction.md
      - Auto-Calibration: hardware/cameras/auto-calibration.md
  - Software:
    - software/index.md
    - Pi Setup:
      - software/pi-setup/index.md
      - Install OS: software/pi-setup/install-os.md
      - First Login: software/pi-setup/first-login.md
      - Advanced Config: software/pi-setup/advanced.md
    - Installation:
      - software/installation/index.md
      - Build from Source: software/installation/build-from-source.md
      - First Use: software/installation/first-use.md
      - Managing PiTrac: software/installation/managing.md
      - Troubleshooting: software/installation/troubleshooting.md
    - Using PiTrac:
      - software/using-pitrac/index.md
      - Dashboard: software/using-pitrac/dashboard.md
      - Configuration: software/using-pitrac/configuration.md
      - Calibration: software/using-pitrac/calibration.md
      - Testing Tools: software/using-pitrac/testing.md
      - Logs: software/using-pitrac/logs.md
      - System Update: software/using-pitrac/system-update.md
    - Simulator Integration: software/simulator-integration.md
  - Reference:
    - reference/index.md
    - Troubleshooting: reference/troubleshooting.md
    - Files and Logs: reference/files-and-logs.md
    - Glossary: reference/glossary.md
    - Known Issues: reference/known-issues.md
    - Roadmap: reference/roadmap.md
    - Contributors: reference/contributors.md
  - Developer Guide:
    - developer/index.md
    - System Overview: developer/overview.md
    - Configuration: developer/configuration.md
    - Services: developer/services.md
    - Testing: developer/testing.md
    - Dependencies: developer/dependencies.md
  - Legacy:
    - legacy/index.md
    - Connector Boards: legacy/connector-boards.md
    - V2 Board Modification: legacy/v2-board-modification.md
    - 3D Printing (V1/V2): legacy/3d-printing.md
    - V1 Enclosure Assembly: legacy/enclosure-assembly.md