site_name: icom-lan
site_description: Python library for controlling Icom transceivers over LAN
site_url: https://morozsm.github.io/icom-lan
repo_url: https://github.com/morozsm/icom-lan
repo_name: morozsm/icom-lan

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            heading_level: 3

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: guide/installation.md
      - Quick Start: guide/quickstart.md
      - CLI Reference: guide/cli.md
      - Configuration: guide/configuration.md
  - User Guide:
      - Connection Lifecycle: guide/connection.md
      - CI-V Commands: guide/commands.md
      - Supported Radios: guide/radios.md
      - Troubleshooting: guide/troubleshooting.md
  - API Reference:
      - IcomRadio: api/radio.md
      - Transport: api/transport.md
      - Commands: api/commands.md
      - Types & Enums: api/types.md
      - Authentication: api/auth.md
      - Exceptions: api/exceptions.md
  - Internals:
      - Architecture: internals/architecture.md
      - Protocol Deep Dive: internals/protocol.md
      - Contributing: internals/contributing.md
      - Roadmap: ROADMAP.md
      - Changelog: CHANGELOG.md
      - Security: SECURITY.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/morozsm/icom-lan
