modelgauge/mkdocs.yml at main · mlcommons/modelgauge · 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
site_name: ModelGauge
repo_url: https://github.com/mlcommons/modelgauge/
edit_uri: blob/main/docs/
theme:
  name: "material"
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.tabs.sticky
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_symbol_type_heading: true
            show_signature_annotations: true
            signature_crossrefs: true
            docstring_section_style: table
            members_order: "source"
nav:
  - index.md
  - User Guide:
    - user_quick_start.md
    - prompt_response_tests.md
    - tutorial.md
    - tutorial_tests.md
    - tutorial_suts.md
  - Developer Guide:
    - dev_quick_start.md
    - plugins.md
    - design_philosophy.md
    - publishing.md
  - API Reference:
      - SUTs:
        - sut: API/sut.md
        - sut_capabilities: API/sut_capabilities.md
        - sut_decorator: API/sut_decorator.md
        - Data Types: API/prompt.md
      - Tests:
        - test: API/test.md
        - test_decorator: API/test_decorator.md
        - Dependency Management: API/dependency_management.md
        - Data Types: API/single_turn_prompt_response.md
      - Misc.: # This can be organized differently.
        - Annotator: API/annotator.md
        - Initialization record: API/record_init.md