site_name: GreatAI documentation
site_description: GreatAI helps you easily transform your prototype AI code into production-ready software.
site_author: András Schmelczer

repo_url: https://github.com/schmelczer/great-ai
repo_name: schmelczer/great-ai
edit_uri: edit/main/docs/

copyright: GNU General Public License v3

extra:
  generator: false
  social:
    - icon: fontawesome/solid/code
      link: https://schmelczer.dev
      name: about the author
    - icon: fontawesome/brands/github
      link: https://github.com/schmelczer/great-ai
      name: great-ai on Github
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/repository/docker/schmelczera/great-ai
      name: great-ai on DockerHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/great-ai
      name: great-ai on PyPI

theme:
  name: "material"
  custom_dir: docs/overrides
  homepage: https://great-ai.scoutinscience.com
  favicon: media/favicon.ico
  features:
    - content.code.annotate
    - content.tooltips
  palette:
    - scheme: default
      primary: light blue
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - scheme: slate
      primary: light blue
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

watch:
  - docs
  - mkdocs.yaml

plugins:
  - git-revision-date-localized:
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_toc_entry: false
            show_root_full_path: false
            heading_level: 3
  - search
  - mkdocs-jupyter:
      include_source: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: "#"
  - admonition
  - pymdownx.details
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - abbr
  - attr_list
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

nav:
  - Overview: index.md
  - Tutorial:
      - Tutorial overview: tutorial/index.md
      - tutorial/train.ipynb
      - tutorial/deploy.ipynb
  - User Guides:
      - how-to-guides/install.md
      - how-to-guides/create-service.md
      - how-to-guides/configure-service.md
      - how-to-guides/use-service.md
      - how-to-guides/handle-training-data.md
      - how-to-guides/large-file.md
      - how-to-guides/call-remote.md
  - Reference:
      - reference/index.md
      - reference/utilities.md
      - reference/large-file.md
      - reference/views.md
  - Examples:
      - Explainable Naive Bayes:
          - examples/simple/data.ipynb
          - examples/simple/train.ipynb
          - examples/simple/deploy.ipynb
      - Explainable SciBERT:
          - examples/scibert/index.md
          - examples/scibert/data.ipynb
          - examples/scibert/train.ipynb
          - examples/scibert/deploy.ipynb
          - examples/scibert/additional-files.md
  - explanation.md