mkdocs.yml

site_name: lip-dp

# Set navigation here
nav:
  - Home: index.md
  - API Reference:
      - deel.lipdp.layers module: api/layers.md
      - deel.lipdp.losses module: api/losses.md
      - deel.lipdp.model module: api/model.md
      - deel.lipdp.pipeline module: api/pipeline.md
      - deel.lipdp.sensitivity module: api/sensitivity.md
  - Tutorials:
    - "Basic use on MNIST": notebooks/basic_mnist.ipynb
    - "Residuals and dynamic clipping on CIFAR10": notebooks/advanced_cifar10.ipynb
  - Contributing: CONTRIBUTING.md

theme:
  name: "material"
  logo: assets/lipdp_logo.png
  favicon: assets/lipdp_logo.png
  palette:
    - scheme: default
      primary: dark
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings
  - mknotebooks

markdown_extensions:
  - footnotes
  - extra
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight
  - pymdownx.superfences
  - codehilite
  - toc:
      baselevel: 1
      permalink: true
      toc_depth: 1-4
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra_css:
  - css/custom.css

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

repo_name: "Algue-Rythme/lip-dp"
repo_url: "https://github.com/Algue-Rythme/lip-dp"