site_name: "sebeni@docs:~$"
site_description: Self-aware morphotactic generation toolkit for extremely low-resource languages
site_url: https://seben.robotsmali.org/docs/
site_author: RobotsMali
repo_url: https://github.com/mlsftwrs/sebeni
repo_name: mlsftwrs/sebeni
edit_uri: ""
copyright: "sebeni - write in Malian languages"

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github
  font:
    text: "JetBrains Mono"
    code: "JetBrains Mono"
  palette:
    - scheme: cli-dark
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - scheme: cli-light
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow

extra:
  homepage: https://seben.robotsmali.org
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mlsftwrs/sebeni
    - icon: simple/huggingface
      link: https://huggingface.co/mlsftwrs

extra_css:
  - stylesheets/terminal.css
  - stylesheets/extra.css

extra_javascript:
  - javascripts/typewriter.js
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "#"

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true

nav:
  - Home: index.md
  - Getting started:
      - Install and run: getting-started.md
      - Experiments: experiments.md
      - Use cases: use-cases.md
  - How it works:
      - SAMPG: sampg.md
      - Architecture: architecture.md
      - Languages: languages.md
      - Distillation and DabaX: distillation.md
      - Rewards and metrics: rewards.md
      - Safety: safety.md
  - Reference:
      - CLI and config: cli.md
      - Hyperparameters: hyperparams.md
      - Wordfreq: wordfreq.md
      - Hub: hub.md
      - Contributing: contributing.md
      - API:
          - Overview: api/index.md
          - SRL: api/srl.md
          - Safety: api/safety.md
          - Compute: api/compute.md
          - CLI: api/cli.md
          - Language: api/language.md
          - Distiller / DabaX: api/morphotactic.md
