mkdocs.yml

docs_dir: .

# Project information
site_name: OpenSR test
site_url: https://github.com/ESAOpenSR/opensr-test
site_author: Open SR test Contributors
site_description: A comprehensive benchmark for real-world Sentinel-2 imagery super-resolution


# Repository
repo_url: https://github.com/ESAOpenSR/opensr-test
repo_name: OpenSR test
use_directory_urls: false

# Configuration
theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: '#201357'
      accent: white
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: docs/images/logo.png
  favicon: resources/ms_icon.png
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - navigation.expand
    - navigation.indexes
    - header.autohide

# Page tree
nav:
  - Home:
    - README.md
    - Contributing: docs/CONTRIBUTING.md
    - Code of Conduct: docs/Code_of_Conduct.md
    - Changelog: docs/CHANGELOG.md
    - License: docs/LICENSE.md
  - API:
    - Config: docs/API/config_pydantic.md
    - Compute method: docs/API/compute_method.md    
    - Results attributes: docs/API/results_attributes.md
  - Metrics:
    - Distance metrics: docs/Metrics/distance.md
    - Correctness scores: docs/Metrics/correctness.md

# Plugins
plugins:
  - search
  - same-dir
  - mkdocstrings 
  - awesome-pages

markdown_extensions:
  - meta
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.pathconverter
  - pymdownx.tabbed
  - mdx_truly_sane_lists
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true
  
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js