veadk-python/docs/mkdocs.yml at 5fb6dd81f886055c2be03b9b2e9b85db651eac6e · volcengine/veadk-python · 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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
site_name: Volcengine ADK
site_description: Documents for Volcengine Agent Development Kit
site_url: https://volcengine.github.io/veadk-python/
repo_url: https://github.com/volcengine/veadk-python
repo_name: volcengine/veadk-python
copyright: Copyright &copy; 2025 Volcengine

edit_uri: edit/main/docs/docs/

theme:
  name: material
  logo: assets/images/volcengine-color.svg
  favicon: assets/images/volcengine-color.svg
  language: zh
  palette:
    scheme: black
  font:
    text: SF Pro Display
    code: Maple Mono
  features:
    - search.share
    - navigation.footer
    # - navigation.instant.preview
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.instant.progress
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.select

nav:
  - 文档:
    - 欢迎: index.md
    - 初识 VeADK 世界: veadk.md
    - 企业级 Agent 设计：从 0 到 1: design.md
    - 快速开始: quickstart.md
    - 配置项: configuration.md
    - 常见问题: troubleshooting.md
    - Hello Agent:
      - 概述: agent/overview.md
      - 构建智能体: agent/agent.md
      - 多智能体交互: agent/agents.md
      - A2A 协议: agent/agent-to-agent.md
      - Prompt 管理: agent/prompt.md
    - 执行引擎:
      - Runner: runner.md
    - 个性化引擎——记忆:
      - 短期记忆: memory/short-term-memory.md
      - 长期记忆: memory/long-term-memory.md
      # - 最佳实践（记忆相关）: memory/best-practice-memory.md
    - 连接能力源——工具:
      - 内置工具: tools/builtin.md
      - 自定义工具: tools/function.md
      - 护栏工具: tools/guardrail.md
    - 连接数据源——知识库:
      - 基本使用: knowledgebase/overview.md
      - 最佳实践（知识库相关）: knowledgebase/best-practice-knowledgebase.md
    - 身份与权限:
      - 概述: auth/overview.md
      - 入站认证: auth/inbound.md
      - 使用 API Key 进行出站认证: auth/api-key-outbound.md
      - OAuth2 用户联邦出站认证: auth/oauth2-user-federation-outbound.md
      - OAuth2 M2M 出站认证: auth/oauth2-m2m-outbound.md
      - Trusted MCP 出站认证: auth/trusted-mcp-outbound.md
    - 可观测:
      - 开启观测: observation/tracing.md
      - 在火山引擎观测: observation/ve-tracing.md
      - 埋点与字段规范: observation/span-attributes.md
    - 部署与持续优化:
      - 部署到 AgentKit: deploy/deploy-agentkit.md
      - 部署到 VeFaaS: deploy/deploy-vefaas.md
      - 评测: deploy/evaluation.md
      - 持续优化: deploy/optimization.md
    - 命令行工具: cli.md
  - 参考:
    - API References: references/api.md
    - 贡献代码: references/contributing.md
    - License: references/license.md
  - IDE 支持:
    - 系统提示词: ide/txt.md
    # - snippets.json: ide/snippets.md
  # - VeADK Gallery:
  #   - Agent 示例: gallery/agent-gallery.md
  #   - 应用示例: gallery/app-gallery.md

plugins:
  - search
  - mkdocs-video:
      is_video: True
      video_muted: True
      video_controls: True
      css_style:
        width: "80%"
        display: "block"
        margin: "0 auto"
        border-radius: "8px"
        box-shadow: "0 4px 12px rgba(0, 0, 0, 0.25)"
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - llmstxt:
      full_output: llms-full.txt
      markdown_description: VeADK.
      sections:
        Usage documentation:
        - index.md
        - quickstart.md
        - runner.md
        - tools/builtin.md
        - tools/function.md
        - knowledgebase/overview.md
        - memory/short-term-memory.md
        - memory/long-term-memory.md
        - observation/tracing.md
        - observation/ve-tracing.md
        - deploy/deploy-vefaas.md
        - deploy/deploy-agentkit.md
        - deploy/evaluation.md
        - deploy/optimization.md

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/volcengine/veadk-python
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/veadk-python

extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - def_list
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - mkdocs-click
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      dedent_subsections: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - toc:
      permalink: true
      title: 导航
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format