mkdocs.yml

# project
site_name: 'earthlib'
site_description: 'Spectral unmixing tools for satellite land cover mapping.'

# documentation build
docs_dir: 'docs'
site_dir: 'build'

# site info
repo_name: 'earth-chris/earthlib'
repo_url: 'https://github.com/earth-chris/earthlib'
site_url: 'https://earth-chris.github.io/earthlib/'

# social
extra:
    social:
      - icon: 'fontawesome/brands/github'
        link: 'https://github.com/earth-chris'
      - icon: 'fontawesome/brands/twitter'
        link: 'https://twitter.com/earth_chris'
      - icon: 'material/earth'
        link: 'https://cbanderson.info/'

# site navigation
nav:
    - Home: 'index.md'
    - Introduction: 'introduction.md'
    - Data Sources: 'sources.md'
    - Code Documentation:
        - earthlib.BRDFCorrect: 'module/BRDFCorrect.md'
        - earthlib.BrightMask: 'module/BrightMask.md'
        - earthlib.BurnPVSoil: 'module/BurnPVSoil.md'
        - earthlib.CloudMask: 'module/CloudMask.md'
        - earthlib.NIRv: 'module/NIRv.md'
        - earthlib.Scale: 'module/Scale.md'
        - earthlib.ShadeMask: 'module/ShadeMask.md'
        - earthlib.SoilPVNPV: 'module/SoilPVNPV.md'
        - earthlib.Unmix: 'module/Unmix.md'
        - earthlib.VegImperviousSoil: 'module/VegImperviousSoil.md'
        - earthlib.config: 'module/config.md'
        - earthlib.errors: 'module/errors.md'
        - earthlib.read: 'module/read.md'
        - earthlib.utils: 'module/utils.md'

# theme
theme:
    logo: 'img/earthlib.svg'
    icon:
      repo: 'fontawesome/brands/github'
    name: 'material'
    language: 'en'
    nav_style: dark
    palette:
      - media: "(prefers-color-scheme: light)"
        scheme: 'earthchris-light'
        toggle:
          icon: 'material/weather-night'
          name: 'Go dark'
      - media: "(prefers-color-scheme: dark)"
        scheme: 'slate'
        toggle:
          icon: 'material/weather-sunny'
          name: 'Go light'
    font:
      text: 'Nunito'
      code: 'Source Code Pro'
    favicon: 'img/favicon.png'
    features:
      - navigation.top

# extras
plugins:
    - search
    - mkdocstrings
    - mkdocs-jupyter:
        include_source: True

extra_css:
        - https://earth-chris.github.io/shared/mkdocs.css

# pandoc (https://pandoc.org/MANUAL.html)
markdown_extensions:
    - admonition
    - attr_list
    - codehilite:
        guess_lang: false
    - def_list
    - footnotes
    - pymdownx.arithmatex
    - pymdownx.betterem
    - pymdownx.caret:
        insert: false
    - pymdownx.details
    - pymdownx.emoji
    - pymdownx.escapeall:
        hardbreak: true
        nbsp: true
    - pymdownx.magiclink:
        hide_protocol: true
        repo_url_shortener: true
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
        custom_checkbox: true
    - pymdownx.tilde
    - toc:
        permalink: true