mkdocs.yml

site_name: Safe-DS Python Library
repo_url: https://github.com/Safe-DS/Library
repo_name: Safe-DS/Library
edit_uri: edit/main/docs/
site_url: !ENV READTHEDOCS_CANONICAL_URL
strict: true

nav:
  - Home:
    - README.md
    - CHANGELOG.md
  - Tutorials:
    - Data Processing: tutorials/data_processing.ipynb
    - Image processing: tutorials/image_processing.ipynb
    - ImageList processing: tutorials/image_list_processing.ipynb
    - Data Visualization: tutorials/data_visualization.ipynb
    - Classification: tutorials/classification.ipynb
    - Regression: tutorials/regression.ipynb
    - Machine Learning: tutorials/machine_learning.ipynb
    - Image Classification with Convolutional Neural Networks: tutorials/convolutional_neural_network_for_image_classification.ipynb
    - Time series forecasting: tutorials/time_series_forecasting.ipynb
  - API Reference: reference/
  - Glossary: glossary.md
  - Development:
    - Environment: development/environment.md
    - Guidelines:
      - Design: development/guidelines/design.md
      - Documentation: development/guidelines/documentation.md
      - Tests: development/guidelines/tests.md
      - Code Style: development/guidelines/code_style.md
      - Code Review: development/guidelines/code_review.md
    - External:
      - Contributing 🌐: https://github.com/Safe-DS/Library/contribute

# Configuration of MkDocs & Material for MkDocs --------------------------------

theme:
  name: material
  logo: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/safe-ds_logo_rounded.svg
  favicon: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/safe-ds_logo_rounded.svg
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: indigo
      accent: indigo

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: black
      accent: indigo
  features:
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: numpy
            filters:
              - "!^_"  # Hide internal & dunder methods
            inherited_members: true
            show_if_no_docstring: true
            show_labels: false
            show_signature: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
  - gen-files:
      scripts:
        - docs/reference/generate_reference_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - autorefs
  - glightbox
  - search
  - mkdocs-jupyter:
      include: ["*.ipynb"]
      execute: true
      allow_errors: false
  - exclude:
      glob:
        - "*.csv"
        - "*.py"

watch:
  - src

markdown_extensions:
  # Admonitions
  - admonition
  - pymdownx.details

  # Code blocks
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

  # Diagrams
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # Footnotes
  - footnotes

  # Keys
  - pymdownx.keys

  # Icons & emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  # Images
  - attr_list
  - md_in_html

  # Lists
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

  # MathJax
  - pymdownx.arithmatex:
      generic: true

  # Permalinks
  - toc:
      permalink: true

  # Tabs
  - pymdownx.tabbed:
      alternate_style: true

extra_css:
  - stylesheets/jupyter.css

extra_javascript:
  - javascript/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js