docent/mkdocs.yml at main · TransluceAI/docent · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
site_name: Transluce Docent
theme:
  name: material
  features:
    # Allows copying code blocks
    - content.code.copy
    # Allows selecting code blocks
    - content.code.select
    # Shows the current path in the sidebar
    - navigation.path
    # Shows sections in the sidebar
    - navigation.sections
    # Shows sections expanded by default
    - navigation.expand
    # Enables annotations in code blocks
    - content.code.annotate
    # Enable content tabs
    - content.tabs.link
  palette:
    primary: black
  logo: images/logo.png
  favicon: images/favicon.ico

nav:
  - Introduction: index.md
  - Quickstart: quickstart.md
  - Tracing: tracing/introduction.md
  - Get support: support.md
  - Tutorials:
      - tutorials/search_and_clustering.md
      - tutorials/logging_agent_runs.md
  - Core Concepts:
      - Data Models:
          - concepts/data_models/agent_run.md
          - concepts/data_models/transcript.md
          - concepts/data_models/metadata.md
          - concepts/data_models/chat_messages.md
          # - concepts/data_models/filters_and_dimensions.md
          - concepts/data_models/llm_output.md
      # - Developers:
      #     - developers/development_tips.md
  # - Integrations:
  #     - integrations/inspect.md
  - Hosting:
      - self_hosting/self_host_docent.md
      - Configuration:
          - self_hosting/environment_variables.md
          - self_hosting/llm_providers_and_calls.md

repo_name: Docent
repo_url: https://github.com/TransluceAI/docent
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: ["docent/data_models"]
          selection:
            docstring_style: google
          options:
            # Shows links to other members in signatures
            signature_crossrefs: true
            # Orders members by source order, rather than alphabetical
            members_order: source
            # Puts the signature on a separate line from the member name
            separate_signature: true
            # Shows type annotations in signatures
            show_signature_annotations: true
            # Makes the font sizes nicer
            heading_level: 2
            # Show inherited members
            inherited_members: true
            # Enable automatic references
            show_root_heading: true
            show_root_full_path: true
            show_object_full_path: false
            show_category_heading: false

extra:
  generator: false
  language: en

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - scripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

extra_css:
  - styles/extra.css