youtu-agent/mkdocs.yml at main · TencentCloudADP/youtu-agent · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# https://github.com/squidfunk/mkdocs-material

site_name: Youtu-Agent
site_url: https://tencentcloudadp.github.io/youtu-agent/
theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Toggle to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Toggle to light mode
      # primary: deep purple
      # accent: purple
  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 tabs on top
    - navigation.tabs
    # Shows sections expanded by default
    # - navigation.expand
    # Enables annotations in code blocks
    - content.code.annotate
  logo: assets/logo.svg
  favicon: assets/logo.svg

repo_name: Youtu-Agent
repo_url: https://github.com/TencentCloudADP/youtu-agent

extra:
  # Remove material generation message in footer
  generator: false
  language: en
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics
  analytics:
    provider: google
    property: G-1DEBDNWPB5
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://doc.weixin.qq.com/smartsheet/form/1_wpkSFfCgAAIzkZ-F0ncReQFci0uBXXig_a04906" target="_blank" rel="noopener">feedback form</a>.


plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["utu"]
          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: 3
            # Show inherited members
            inherited_members: true
            # show_root_heading: true
            show_source: true

# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions
markdown_extensions:
  # https://squidfunk.github.io/mkdocs-material/reference/diagrams
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details

extra_css:
  - stylesheets/extra.css

watch:
  - utu

nav:
  - Intro:
    - Introduction: index.md
    - FAQ: faq.md
  - Quickstart:
    - QuickStart (for beginner): quickstart_beginner.md
    - QuickStart: quickstart.md
    - Start with Docker: docker.md
  - Howto:
    - Evaluate an Agent: howto/eval.md
    - Customize an YAML Config: howto/config.md
    - Use agent skills: howto/skills.md
  - Documentation:
    - Config: config.md
    - Environment Variables: environment_variables.md
    - Agents: agents.md
    - Agent Environments: env.md
    - Tools: tools.md
    - Evaluation: eval.md
    - Agent Practice: practice.md
    - WebUI: frontend.md
    - Automatic Generation: auto_generation.md
  - Examples:
    - Examples: examples.md
    - Examples Output:
      - Deep Research: examples_output/deep_research.md
      - Wide Research: examples_output/wide_research.md
      # - Data Analysis: examples_output/data_analysis.md
  - API Reference:
    - Agents:
      - ref/agents/simple_agent.md
      - ref/agents/orchestra_agent.md
    - Tools:
      - ref/tool/base_toolkit.md
      - ref/tool/search_toolkit.md
      - ref/tool/document_toolkit.md
      - ref/tool/image_toolkit.md
      - ref/tool/video_toolkit.md
      - ref/tool/codesnip_toolkit.md
      - ref/tool/bash_toolkit.md
      - ref/tool/python_executor_toolkit.md
    - Environments:
      - ref/env/base_env.md
      - ref/env/browser_env.md
    - Evaluation:
      - ref/eval/data.md
      - ref/eval/processor.md
      - ref/eval/benchmarks.md
    - Utils:
      - ref/utils/openai_utils.md
      - ref/utils/agents_utils.md
    - Config:
      - ref/config/base_config.md
      - ref/config/loader.md
      - ref/config/model_config.md
      - ref/config/agent_config.md
      - ref/config/eval_config.md