site_name: (Py)PolSARpro documentation
repo_url: https://github.com/satim-co/PolSARpro
repo_name: 'satim-co/PolSARpro'
nav:
  - Home: index.md
  - Tutorials:
    - Quickstart: quickstart-tutorial.ipynb
    - Decompositions:
      - freeman: freeman-tutorial.ipynb
      - h-a-alpha: h-a-alpha-tutorial.ipynb
      - tsvm: tsvm-tutorial.ipynb
      - vanzyl: vanzyl-tutorial.ipynb
      - yamaguchi3: yamaguchi3-tutorial.ipynb
      - yamaguchi4: yamaguchi4-tutorial.ipynb
      - cameron: cameron-tutorial.ipynb
    - Speckle filters:
      - refined-lee: refined-lee-tutorial.ipynb
      - pwf: pwf-tutorial.ipynb
    - Classification:
      - wishart-haa: wishart-h-a-alpha-tutorial.ipynb
      - wishart-supervised: wishart-supervised-tutorial.ipynb
      - manual-labeling: manual-labeling-tutorial.ipynb
    - Physical parameter inversion:
      - dubois: dubois-surface-inversion-tutorial.ipynb
    - Advanced usage:
      - biomass-maap: maap-biomass-stac-api.ipynb
  - API reference: 
    - Classification: classification.md
    - Decompositions: decompositions.md
    - Speckle Filters: speckle_filters.md
    - Physical inversion: physical_inversion.md
    - Utilities: util.md
    - Inputs/Outputs: io.md
  - Theory: theory.md

theme:
  name: material
  logo: polsarpro_icon.svg
  favicon: polsarpro_icon.svg
  highlightjs: true
  hljslanguages:
    - python
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
  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: [polsarpro]
          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
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js