mkdocs.yml

site_url: https://Doodleverse.github.io/SDStools/
site_name: SDStools
site_description: A toolbox for filtering outliers, analyzing and find trends in times series shoreline data from CoastSeg.

repo_url: https://github.com/Doodleverse/SDStools
repo_name: SDStools
edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    logo: material/tools
    favicon: material/tools

  palette:
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

plugins:
  - search

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Installation:
      - Installation Guide: install-guide.md
  - Guides:
      - 1. Filter outliers in spatio-temporal SDS data: filter_outliers_guide.md
      - 2. Fill in missing values in spatio-temporal SDS data: inpaint_spacetime_guide.md
      - 3. Detrend spatio-temporal SDS data relative to start: detrend_spacetime_guide.md
      - 4. Denoise spatio-temporal SDS data: denoise_inpainted_spacetime_guide.md
      - 5. Statistically analyze each transect: analyze_transects_guide.md
      - 6. Download ERA5 wave hindcast: download_waves_guide.md
      - 7. Download topobathy data: download_topobathy_guide.md