mkdocs.yml

# Project
site_name: Open Energy Academy
site_url: https://openenergyplatform.github.io/academy
site_description: A collection of courses, tutorials, and questions for the Open Energy Family

# Repository
repo_name: academy
repo_url: https://github.com/OpenEnergyPlatform/academy
docs_dir: docs

# Configuration
theme:
  name: material
  logo: data/img/OpenEnergyFamily_Logo_Academy_white.png
  locale: en
  include_sidebar: false
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  icon:
    repo: fontawesome/brands/github

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.path
    - navigation.tracking
    - navigation.footer
    - navigation.top
    - toc.follow
    - search.suggest
    - search.share

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: "#"

plugins:
  - mkdocs-jupyter:
      include_source: True
  - search:
      lang: de
  - mkdocs-oep:
      icon:
        code: fontawesome-solid-code
        text: fontawesome-solid-bookmark
        info: fontawesome-solid-info
        video: fontawesome-solid-play
        mail: fontawesome-solid-envelope
        github: fontawesome-brands-github
      logo:
        sirop: SIROP_logo_50.png
        oep: OEP_logo_2_no_text.svg
        bmwk: BMWK_Logo_mit_Foerderzusatz_en.png
  - redirects:
      # redirect pages where we already published the urls
      redirect_maps:
        tutorials/other/1_checklist.md: tutorials/99_other/checklist.md
        tutorials/upload/data_preprocessing/7_database_data.md: tutorials/99_other/database_data.md
        tutorials/upload/08_upload.md: courses/04_upload.md
        tutorials/upload/11_beginners_guide.md: tutorials/99_other/beginners_guide.md
        tutorials/metadata/tutorial_open-data-licenses.md: tutorials/99_other/tutorial_open-data-licenses.ipynb
        tutorials/metadata/16_licensing.md: courses/08_licensing.md
  - include_dir_to_nav:
      file_pattern: '.*\.(md|ipynb)$'

# Customization
extra:
  generator: false
  homepage: https://openenergyplatform.github.io/academy/

extra_css:
  - css/extra.css

nav:
  - Start: index.md
  - Courses: courses/
  # manually add subfolders so we can rename the section titles
  - Tutorials:
      - index.md: tutorials/index.md
      - API: tutorials/01_api/
      - OEP Client: tutorials/02_oep_client/
      - External: tutorials/03_external/
      - Other: tutorials/99_other/
  - Questions: questions.md
  - Metainfo: meta.md

# new in mkdocs 1.5
# NOTE: this only suppresses warning
not_in_nav: |
  legacy/*