STEB/mkdocs.yml at main · rrivera1849/STEB · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
site_name: STEB
site_description: Style Text Embedding Benchmark
site_url: https://steb.readthedocs.io
repo_url: https://github.com/rrivera1849/STEB
repo_name: rrivera1849/STEB

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - toc.follow

nav:
  - Home: index.md
  - Leaderboard: leaderboard.md
  - Getting Started: getting-started.md
  - Usage:
      - CLI: usage/cli.md
      - Python API: usage/python-api.md
  - Tasks:
      - Overview: tasks/overview.md
      - Clustering: tasks/clustering.md
      - All-to-All Pair Classification: tasks/all-to-all-pair-classification.md
      - Pre-defined Pair Classification: tasks/pre-defined-pair-classification.md
      - Order Alignment: tasks/order-alignment.md
      - Retrieval: tasks/retrieval.md
      - Probing: tasks/probing.md
      - Hungarian Algorithm: tasks/hungarian-algorithm.md
  - Developer Guide:
      - Adding Models: developer/adding-models.md
      - Adding Datasets: developer/adding-datasets.md
      - Running Tests: developer/running-tests.md
  - API Reference: api-reference.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            members_order: source