asrbench/mkdocs.yml at main · ASRBench/asrbench · 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
site_name: ASRBench
repo_url: https://github.com/ASRBench/asrbench
repo_name: ASRBench/asrbench
# edit_uri: tree/main/docs
nav:
  - AsrBench: index.md
  - Getting started:
      - Installation: installation.md
      - Configuration: configuration.md
      - Usage: usage.md
  - Learn:
      - New Transcriber: learn/new-transcriber.md
  - References:
      - ConfigLoader: references/configloader.md
      - Dataset: references/dataset.md
      - Benchmark: references/benchmark.md
      - Transcribe Data: references/transcribe.md
      - Transcribers:
          - Registry: references/transcribers/registry.md
          - Transcriber: references/transcribers/transcriber.md
          - Factory: references/transcribers/factory.md
      - Utils: references/utils.md
      - Output: references/output.md
      - Observer: references/observer.md
      - Jiwer: references/jiwer.md
  - Cli:
      - Installation: cli/installation.md
      - Configuration: cli/configuration.md
      - Usage: cli/usage.md
      - Transcribers: cli/transcribers.md

theme:
  name: material
  # logo: assets/logo.png
  # favicon: assets/logo.png
  palette:
    - scheme: default
      primary: green
      accent: amber
      toggle:
        icon: material/weather-night
        name: Dark Mode
    - scheme: slate
      primary: green
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Light Mode
  features:
    - content.code.copy
    - navigation.tabs


markdown_extensions:
  - attr_list
  - pymdownx.superfences
  - pymdownx.emoji
  - pymdownx.details
  - admonition

#extra_css:
#  - stylesheets/extra.css

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [asrbench, asrbench/transcribers]