mkdocs.yml

---
site_name: YiVal
nav:
  - Index: index.md
  - Eng Spec:
      - Arctitecture: architecture.md
      - Demo:
          - Basic Interactive Mode: basic_interactive_mode.md
          - Question Answering with Expected Results: qa_expected_results.md
          - Auto Prompts Generation: auto_prompts_generation.md
      - Custom Classes:
          - Custom Evaluator: custom_classes/evaluators.md
          - Custom Wrapper: custom_classes/wrappers.md
          - Custom Data Generator: custom_classes/data_generators.md
          - Custom Variation Generator: custom_classes/variation_generators.md
          - Custom Reader: custom_classes/readers.md
          - Custom Combination Improver: custom_classes/improvers.md
          - Custom Selection Strategy: custom_classes/selection_strategy.md

  - Contributing Guide: contributing.md
  - Code Reference:
      - yival.configs.config_utils: code/configs/config_utils.md
      - yival.data_generators.base_data_generator: code/data_generators/base_data_generator.md
      - yival.combination_improvers.base_combination_improver: code/combination_improvers/base_combination_improver.md
      - yival.data.base_reader: code/data/base_reader.md
      - yival.evaluators.base_evaluator: code/evaluators/base_evaluator.md
      - yival.result_selectors.selection_strategy: code/result_selectors/selection_strategy.md
      - yival.states.experiment_state: code/states/experiment_state.md
      - yival.variation_generators.base_variation_generator: code/variation_generators/base_variation_generator.md
      - yival.wrappers.base_wrapper: code/wrappers/base_wrapper.md

theme:
  name: material
  palette:
    cheme: slate
    primary: lightgreen
    accent: purple
  logo: https://avatars.githubusercontent.com/u/134003593?s=400&u=34efa0d11568c1b5956f2e48dec7d15d95252a73&v=4
  favicon: fontawesome/brands/github
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.top
    - header.autohide
  font: false
repo_url: https://github.com/YiVal/YiVal
repo_name: YiVal/YiVal
extra:
  homepage: https://yival.io

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - extra
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      lang:
        - en
        - ja
  - mkdocstrings:
      watch:
        - src
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
  - macros
  - git-revision-date-localized:
      type: timeago
      fallback_to_build_date: true