mkdocs.yml

site_name: MLPotion - Machine Learning Potion
site_url: https://github.com/UnicoLab/MLPotion
docs_dir: docs
theme:
  name: "material"
  icon:
    logo: material/atom
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

nav:
  - 🏠 Home: index.md
  - 🚀 Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Core Concepts: getting-started/concepts.md
  - 🔧 Frameworks:
    - TensorFlow: frameworks/tensorflow.md
    - PyTorch: frameworks/pytorch.md
    - Keras: frameworks/keras.md
  - 🔄 Integrations:
    - FlowyML:
      - Overview: integrations/flowyml.md
    - ZenML: integrations/zenml.md
  - 🎓 Tutorials:
    - Basic Pipeline: tutorials/basic-pipeline.md
    - FlowyML Quick Start: tutorials/flowyml-quickstart.md
    - FlowyML Custom Pipelines: tutorials/flowyml-custom-pipeline.md
    - FlowyML Experiment Tracking: tutorials/flowyml-experiment-tracking.md
    - FlowyML Scheduled Retraining: tutorials/flowyml-scheduled-retraining.md
    - ZenML Pipeline: tutorials/zenml-integration.md
    - Multi-Framework: tutorials/multi-framework.md
  - 📖 API Reference:
    - Core: api/core.md
    - TensorFlow: api/frameworks/tensorflow.md
    - PyTorch: api/frameworks/pytorch.md
    - Keras: api/frameworks/keras.md
    - FlowyML: api/integrations/flowyml.md
    - ZenML: api/integrations/zenml.md
  - 🤝 Contributing:
    - Overview: contributing/overview.md

repo_name: ML-Potion
repo_url: https://github.com/UnicoLab/MLPotion

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - tables
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - autorefs:
      link_titles: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            docstring_style: google
            merge_init_into_class: true
            show_category_heading: true
  - mike:
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
      # Copy files instead of creating symlinks (GitHub Pages doesn't follow symlinks)
      alias_type: copy

  - include-markdown:
      encoding: ascii
      preserve_includer_indent: false
      dedent: false
      trailing_newlines: true
      comments: true
      rewrite_relative_urls: true
      heading_offset: 0
      start: <!--start-->
      end: <!--end-->
      recursive: true


# Disable directory URLs to make relative paths work better
use_directory_urls: false

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/UnicoLab/MLPotion
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/mlpotion/

extra_javascript:
  - assets/js/fix-image-paths.js