mkdocs.yml

site_name: geo-track-analyzer
site_description: Toolbox for analyzing and visualizing geo data tracks
site_author: Korbinian Schweiger
repo_url: https://github.com/kschweiger/track_analyzer
repo_name: kschweiger/track_analyzer

nav:
  - About: index.md
  - Usage:
      - Getting Started: usage.md
      - Visualization:
          - Track profiles and maps: vis_profiles_and_maps.md
          - Summaries: vis_summaries.md
      - Comparison: comparison.md
      - Enhancer: enhancer.md
      - CLI: cli.md
  - API Reference:
      - Track Reference: api_tracks.md
      - Model Reference: api_model.md
      - Enhancer Reference: api_enhancer.md
      - Visualization Reference: api_visualizations.md
      - Comparison Reference: api_comparison.md
  - Miscellaneous:
      - Changelog: changelog.md

theme:
  name: material
  icon:
    repo: fontawesome/brands/git-alt
    logo: material/compass-outline
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - content.action.edit
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.instant
    - navigation.sections

markdown_extensions:
  - admonition
  - attr_list
  - mkdocs-click
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shortener: true
      social_url_shorthand: true
      normalize_issue_symbols: true
      provider: github
      user: kschweiger
      repo: track_analyzer
  - toc:
      toc_depth: 4

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            heading_level: 3
            show_symbol_type_toc: true
            docstring_style: sphinx
            inherited_members: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_root_full_path: false
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: true
            modernize_annotations: true
            signature_crossrefs: true

exclude_docs: README.md

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/kschweiger
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.social/@kschweiger
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/korbinian-schweiger-973225123/