mkdocs.yml

# Project information
site_name: WaLSAtools
site_description: WaLSAtools – Wave Analysis Tools - is an open-source library for analysing a wide variety of wave phenomena in time series data, including images and multi-dimensional datasets.
site_author: WaLSA Team (https://WaLSA.team)
site_url: https://WaLSA.tools

# Repository
repo_name: WaLSAtools
repo_url: https://github.com/WaLSAteam/WaLSAtools
edit_uri: tree/main/docs/

# Copyright
copyright: Copyright &copy; 2025 <a href="https://WaLSA.team" target="_blank">WaLSA Team</a>

## Social Media
extra:
  social:
    - icon: fontawesome/solid/home
      link: https://WaLSA.team
    - icon: fontawesome/brands/github
      link: https://github.com/WaLSAteam
      name: GitHub.com/WaLSAteam
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/WaLSAteam
      name: Facebook.com/WaLSAteam
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/WaLSAteam
      name: Twitter.com/WaLSAteam
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/walsa-team
      name: LinkedIn.com/company/walsa-team
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/WaLSA_team
      name: Instagram.com/WaLSA_team
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/WaLSAteam
      name: YouTube.com/WaLSAteam
    - icon: fontawesome/solid/envelope
      link: mailto:WaLSAtools@WaLSA.team
      name: Contact us
  disqus: ""
  manifest: manifest.webmanifest
  username: "WaLSA Team"
  password: "WaLSAtools@CaII8542"

# Configuration
theme:
  name: null
  custom_dir: docs/theme
  static_templates:
    - 404.html
  feature:
    tabs: true
  include_search_page: false
  search_index_only: true
  language: en
  features:
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.integrate
    - navigation.indexes
    # - navigation.tracking
    - content.code.annotate
    - navigation.expand
  palette: 
    - scheme: default
      primary: deep-orange
      accent: red
      toggle:
        icon: material/weather-sunny
        name: IDL
    - scheme: default 
      primary: deep-orange
      accent: red
      toggle:
        icon: material/weather-night
        name: Python

  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/misc/favicon.png
  icon:
    logo: logo
    repo: fontawesome/brands/github

# Page tree
nav:
  - Home: index.md

  - Getting started:
    - idl/introduction.md # alias for introduction.md
    # IDL:
    - Installation: idl/installation.md
    - Setting IDL PATH: idl/setting-idl-path.md
    - Troubleshooting: idl/troubleshooting.md

  - Getting started:
    - python/introduction.md # alias for introduction.md
    # Python:
    - Installation: python/installation.md
    - Troubleshooting: python/troubleshooting.md

  # IDL:
  - Analysis Tools: 
    - idl/WaLSAtools.md
    - Examples:
      - Worked examples - NRMP:
          - Power Spectra: idl/power-spectra-example.md
          - Dominant Frequency: idl/dominant-frequency-example.md
          - k-&#969; and POD: idl/k-omega-pod-example.md
          - Cross Correlations: idl/cross-correlation-example.md
          - EMD: idl/emd-example.md
          - EEMD: idl/eemd-example.md
          - k-&#969; analysis: idl/k-omega-example.md
          - POD analysis: idl/pod-example.md
          - POD eigenvalues: idl/pod-eigenvalues-example.md
          - POD filtering: idl/pod-filtering-example.md
          - SPOD analysis: idl/spod-example.md
    - Under the Hood: 
        - Main Routines: idl/routines.md

  # Python:
  - Analysis Tools: 
    - python/WaLSAtools.md
    - Examples:
      - Worked examples - NRMP:
          - Power Spectra: python/power-spectra-example.md
          - Dominant Frequency: python/dominant-frequency-example.md
          - k-&#969; and POD: python/k-omega-pod-example.md
          - Cross Correlations: python/cross-correlation-example.md
          - EMD: python/emd-example.md
          - EEMD: python/eemd-example.md
          - k-&#969; analysis: python/k-omega-example.md
          - POD analysis: python/pod-example.md
          - POD eigenvalues: python/pod-eigenvalues-example.md
          - POD filtering: python/pod-filtering-example.md
          - SPOD analysis: python/spod-example.md
    - Under the Hood:
        - Main Routines: python/routines.md
        
  - About:
    - Contribution: contribution.md
    - Development: development.md
    - License and Credits: license.md
    - Acknowledgements: acknowledgements.md
    - Citation: citation.md
    - Changelog: changelog.md
    - Release Notes:
        - 'v1.0.0': releases/v1.0.0.md

# Plugins
plugins:
  - search
  - exclude-search:
      exclude:
        - python/converted_notebooks_nrmp/*.md
  - include-markdown

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      baselevel: 1
      permalink: true
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.striphtml

extra_css:
  - theme/assets/stylesheets/extra.css

extra_javascript:
  - https://code.jquery.com/jquery-3.5.0.js
  - https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.bundle.min.js
  - javascripts/walsatools-interactive_docs.js
  - javascripts/config.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js