subagents-pydantic-ai/mkdocs.yml at main · vstorm-co/subagents-pydantic-ai · 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
178
179
180
181
182
site_name: Subagents for Pydantic AI
site_description: Multi-Agent Orchestration for Pydantic AI
site_url: https://vstorm-co.github.io/subagents-pydantic-ai/
repo_url: https://github.com/vstorm-co/subagents-pydantic-ai
repo_name: vstorm-co/subagents-pydantic-ai

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  features:
    # Navigation
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Content
    - content.tabs.link
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    # Table of contents
    - toc.follow
    # Header
    - announce.dismiss

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            signature_crossrefs: true

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  # PyMdownx
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - 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
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vstorm-co/subagents-pydantic-ai
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/subagents-pydantic-ai/
      name: PyPI
  generator: false

extra_css:
  - stylesheets/extra.css

nav:
  - Subagents for Pydantic AI: index.md
  - Installation: installation.md
  - Getting Help: getting-help.md
  - Core Concepts:
    - concepts/index.md
    - Capability: concepts/capability.md
    - Subagents: concepts/subagents.md
    - Toolset: concepts/toolset.md
    - Types: concepts/types.md
  - Advanced Features:
    - advanced/execution-modes.md
    - advanced/questions.md
    - advanced/cancellation.md
    - advanced/dynamic-agents.md
    - advanced/message-bus.md
  - Examples:
    - examples/index.md
    - Getting Started:
      - examples/basic-usage.md
      - examples/sync-async.md
    - Agent Features:
      - examples/toolsets.md
      - examples/questions.md
      - examples/nesting.md
    - Applications:
      - examples/research-team.md
  - API Reference:
    - api/index.md
    - Capability: api/capability.md
    - Toolset: api/toolset.md
    - Types: api/types.md
    - Protocols: api/protocols.md

validation:
  nav:
    omitted_files: info