mkdocs.yml

site_name: Mlflow-WatsonML
repo_url: https://github.com/IBM/mlflow-watsonml
repo_name: IBM/mlflow-watsonml
copyright: Copyright © 2023 - 2024 IBM Research
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - content.code.copy
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  palette:
    # Palette toggle for automatic 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
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

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

plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [mlflow_watsonml] # search packages in the src folder
          options:
            docstring_style: numpy

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:dhruv.shah@ibm.com

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences

nav:
  - Home: index.md
  - Getting Started:
      - Installation: install.md
      - Set Up Credentials: credentials.md
  - User Guide: user_guide.md
  - API Reference: api_reference.md