mkdocs.yml

site_name: eo-tools documentation
repo_url: https://github.com/odhondt/eo_tools
repo_name: 'odhondt/eo_tools'
nav:
  - Home: index.md
  - Tutorials:
    - Example 1: s1-discover-insar-pairs.ipynb
    - Example 2: s1-easy-tops-insar.ipynb
    - Example 3: s1-easy-slc-geocoding.ipynb
    - Example 4: s1-easy-terrain-flattening.ipynb
    - Example 5: s1-custom-pipeline.ipynb
    - Example 6: s1-goldstein-phase-denoising.ipynb
    - Example 7: discover-and-process-s2.ipynb
    - Example 8: download-dem.ipynb
  - API reference: 
    - Sentinel-1 core: s1_core_api.md
    - Sentinel-1 processor: s1_process_api.md
    - Sentinel-1 utilities: s1_util_api.md
    - Sentinel-2: s2_api.md
    - DEM: dem_api.md
    - General utilities: util_api.md
  - Version notes: changelog.md 
  # - Version notes: https://github.com/odhondt/eo_tools/blob/main/CHANGELOG.md

theme:
  name: material
  logo: logo-transparent.svg
  favicon: logo-transparent.svg
  highlightjs: true
  hljslanguages:
    - python
  features:
    - navigation.instant
  font:
    text: 'Nunito Sans'
    code: 'Fira Code'
  palette:
    primary: blue grey
    accent: blue grey

  # # Palette toggle for automatic mode
  # - media: "(prefers-color-scheme)"
  #   toggle:
  #     icon: material/brightness-auto
  #     name: Switch to light mode

  # # Palette toggle for light mode
  # - media: "(prefers-color-scheme: light)"
  #   scheme: default 
  #   toggle:
  #     icon: material/brightness-7
  #     name: Switch to dark mode

  # # Palette toggle for dark mode
  # - media: "(prefers-color-scheme: dark)"
  #   scheme: slate
  #   toggle:
  #     icon: material/brightness-4
  #     name: Switch to system preference
plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        # See: https://mkdocstrings.github.io/python/usage/
        python:
          paths: [eo_tools]
          options:
            docstring_style: google
            show_root_heading: true
            heading_level: 1
            show_source: false
markdown_extensions:
  - markdown_include.include:
      base_path: .
  - toc:
      toc_depth: 4
      baselevel: 2
  # - admonition
extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/odhondt'