mkdocs.yml

site_name: OpenML PyTorch Extension
theme:
  name: material
  features:
    - content.code.copy
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: indigo
      accent: indigo
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - admonition
  - codehilite
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true
plugins:
  - search
  - mkdocs-jupyter
  - awesome-pages
  # - mknotebooks:
      # execute: false
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [openml_pytorch]
          load_external_modules: true
          show_source: true
          options:
            docstring_section_style: table
            show_docstring_functions: true

nav:
  - Home: "index.md"
  - API Reference:
    - "Callbacks": "API reference/Callbacks.md"
    - "Custom Datasets": "API reference/Custom Datasets.md"
    - "Metrics" : "API reference/Metrics.md"
    - "OpenML Connection" : "API reference/OpenML Connection.md"
    - "Trainer" : "API reference/Trainer.md"
  - Examples:
    - "Create Dataset and Task" : "Examples/Create Dataset and Task.ipynb"
    - "Image Classification Task" : "Examples/Image Classification Task.ipynb"
    - "Pretrained Transformer Image Classification Task" : "Examples/Pretrained Transformer Image Classification Task.ipynb"
    - "Sequential Classification Task" : "Examples/Sequential Classification Task.ipynb"
    - "Tabular Classification" : "Examples/Tabular Classification.ipynb"
  - "Other Integrations" : "Integrations of OpenML in PyTorch.md"
  - "Limitations of the API":  "Limitations of the API.md"
  - "Philosphy behind the API Design" : "Philosophy behind the API Design.md"