mkdocs.yml

site_name: whiteboxgui

site_url: https://whiteboxgui.gishub.org

repo_url: https://github.com/giswqs/whiteboxgui

theme:
    palette:
        scheme: preference
    name: material
    icon:
        repo: fontawesome/brands/github
    features:
        - navigation.instant
        - search.highlight
        # - navigation.expand
        # - navigation.tabs
    custom_dir: "docs/overrides"

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True
          execute: True
          
markdown_extensions:
    - attr_list
    - toc:
          permalink: true

# google_analytics:
#     - UA-XXXXXXXXX-X
#     - auto

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - Contributing: contributing.md
    - FAQ: faq.md
    - Report Issues: https://github.com/giswqs/whiteboxgui/issues
    - API Reference:
          - whiteboxgui module: whiteboxgui.md
    - Notebooks:
          - examples/examples.ipynb