AutoChecklist/mkdocs.yml at main · ChicagoHAI/AutoChecklist · 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
site_name: autochecklist
site_url: https://autochecklist.github.io/docs/
site_description: A library of checklist generation and scoring methods for evaluation
repo_url: https://github.com/ChicagoHAI/AutoChecklist
repo_name: ChicagoHAI/AutoChecklist

theme:
  name: material
  palette:
    - scheme: default
      primary: custom
      accent: custom
  custom_dir: docs/overrides
  font:
    text: Inter
    code: Space Mono
  logo: assets/ac_white.png
  favicon: assets/ac_bg_dark.png
  features:
    - navigation.sections
    - search.suggest
    - content.code.copy

plugins:
  - search
  - mkdocs-autoapi:
      autoapi_dir: autochecklist
      autoapi_root: autoapi
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Pipeline & Composability: user-guide/pipeline.md
      - Generators: user-guide/generators.md
      - Refiners: user-guide/refiners.md
      - Scorers: user-guide/scorers.md
      - Supported Pipelines: user-guide/supported-pipelines.md
      - Custom Prompts: user-guide/custom-prompts.md
      - CLI: user-guide/cli.md
      - Providers: user-guide/providers.md

extra_css:
  - overrides/extra.css

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true