mkdocs.yml

site_name: Neural Subtitles Translator
repo_url: https://github.com/tdhm/subtitles-translator
site_url: https://tdhm.github.io/subtitles-translator
site_description: Automatic subtitles translation with a local neural machine translation model.
edit_uri: edit/main/docs/
repo_name: tdhm/subtitles-translator

nav:
  - Getting started:
      - Overview: index.md
      - Installation: installation.md
      - How-to guide: how_to.md
      - Available languages: available_languages.md
  - Package reference:
      - Command Line Interface: cli_reference.md
      - Subtitles Class: subtitles_reference.md
      - Translator Class: translator_reference.md
      - FFmpeg utils: ffmpeg_utils_reference.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
            setup_commands:
                - import sys
                - sys.path.append('../')
theme:
  name: material
  feature:
    tabs: true
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tdhm/subtitles-translator
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/subtitles-translator

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - admonition