mkdocs.yml

site_name: relational-datasets
site_description: "A small library for loading and downloading relational datasets."
repo_name: "srlearn/relational-datasets"
site_url: "https://srlearn.github.io/relational-datasets/"
repo_url: https://github.com/srlearn/relational-datasets/
edit_uri: "blob/main/docs/"


theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  features:
    - navigation.instant
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.tasklist

plugins:
  - search
  - mkdocstrings:
      watch:
        - relational_datasets
        - README.md
  - git-revision-date-localized
  - awesome-pages
  - mkdocs-jupyter

nav:
  - Home: index.md
  - API Docs:
    - request.load: api/request.load.md
    - request.fetch: api/request.fetch.md
    - convert.from_numpy: api/convert.from_numpy.md
    - types.RelationalDataset: api/relationaldataset.md
    - Unstable:
      - request.deserialize_zipfile: api/request.deserialize_zipfile.md
      - request.latest_version: api/request.latest_version.md
  - Downloads: downloads.md
  - ... | dataset_descriptions/*.md
  - Notebooks:
    - "Fetching": notebooks/00_loading_and_fetching.ipynb
    - "Converting Vector Datasets": notebooks/01_converting_propositional_datasets.ipynb
    - "Multiclass Datasets": notebooks/02_multiclass.ipynb
  - Changelog: changelog.md