mkdocs.yml

site_name: Model Diagnostics
site_description: Tools for diagnostics and assessment of (machine learning) models
site_author: Christian Lorentzen
site_url: https://lorentzenchr.github.io/model-diagnostics
repo_name: lorentzenchr/model-diagnostics
repo_url: https://github.com/lorentzenchr/model-diagnostics
edit_uri: blob/master/docs
copyright: 'Copyright © Christian Lorentzen 2022-present'

theme:
  name: material

  palette: 
    # Palette toggle for automatic dark/light mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - search.highlight

nav:
  - Home:
    - About: index.md
  - Examples:
    - Regression on Workers' Compensation: examples/regression_on_workers_compensation.ipynb
    - Quantile Regression: examples/quantile_regression.ipynb
    - Classification: examples/classification.ipynb
  - API Reference: reference/  # defer to gen-files + literate-nav
  - Development: development.md
  - Release Notes: https://github.com/lorentzenchr/model-diagnostics/releases

watch:
  - src/model_diagnostics/

plugins:
  # Built-in
  - search:
  # Extra
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: "numpy"
            filters:
              - "!^_[^_]"  # this is the default
              - "!^test"
            inherited_members: true
            show_submodules: false  # this is the default
            # Headings
            show_root_heading: true
            show_root_full_path: false
            # Docstrings
            # show_if_no_docstring: true
            # Signatures/annotations
            show_signature_annotations: false  # type annotations
            # Other
            show_bases: false
            show_source: true
  - mkdocs-jupyter:
      include_requirejs: true  # needed for plotly

markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3  # default = 3

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji 
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js