mkdocs.yml

site_name: ICEcube Documentation
site_description: Manipulate coregistered ICEYE SAR Image Stacks in Python

# Repository
repo_name: iceye-ltd/icecube
repo_url: https://github.com/iceye-ltd/icecube
edit_uri: edit/main/docs/
site_url: https://iceye-ltd.github.io/icecube/

theme:
  palette:
    primary: black
    accent: green
  name: material
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Installation: installation.md
  - ICEcube Examples:
    - Overview : overview.md
    - SARDatacube : examples/Ex1_SARDatacube.ipynb
    - LabelsDatacube : examples/Ex2_LabelsDatacube.ipynb
    - CreatingDatacube: examples/Ex3_CreatingDatacube.ipynb  
    - Datacube : examples/Ex4_Datacube.ipynb
    - Datacube for ML: examples/Ex5_Datacube_for_ML.ipynb

  - Implementation Details:
    - Datacube: datacube/Datacube.md
  - Release Notes: release_notes.md
  - Contributing: contribute.md

markdown_extensions:
  - admonition

plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: false
            show_source: true
            show_category_heading: true
          selection:
            filters:
              - "!^_"  # exlude all members starting with _
      watch:
        - icecube/