Stirrup/mkdocs.yml at main · ArtificialAnalysis/Stirrup · 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
site_name: Stirrup
site_description: A reusable agent framework for building AI agents with tool use
site_author: Artificial Analysis, Inc.
repo_url: https://github.com/ArtificialAnalysis/Stirrup
repo_name: ArtificialAnalysis/Stirrup

theme:
  name: material
  favicon: assets/favicon.ico
  logo: assets/logo.png
  font:
    text: Inter
    code: Roboto Mono
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.expand
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - assets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2
            merge_init_into_class: true
            show_bases: true
            members: true
            members_order: source
            inherited_members: false
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
          inventories:
            - https://docs.python.org/3/objects.inv
          extensions:
            - griffe_pydantic:
                schema: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Core Concepts: concepts.md
  - Examples: examples.md
  - Guides:
      - Creating Tools: guides/tools.md
      - Tool Providers: guides/tool-providers.md
      - Code Execution: guides/code-execution.md
      - Caching: guides/caching.md
      - Skills: guides/skills.md
      - Sub-Agents: guides/sub-agents.md
      - Slack Integration: guides/slack.md
      - MCP Integration: guides/mcp.md
  - Extending:
      - Custom Clients: extending/clients.md
      - Custom Tools: extending/tools.md
      - Custom Loggers: extending/loggers.md
      - Custom Backends: extending/code_backends.md
      - Full Customization: extending/full-customization.md
  - API Reference:
      - Core:
          - Agent: api/core/agent.md
          - Models: api/core/models.md
          - Exceptions: api/core/exceptions.md
      - Clients:
          - ChatCompletions: api/clients/chat_completions.md
          - OpenResponses: api/clients/open_responses.md
          - LiteLLM: api/clients/litellm.md
      - Tools:
          - Overview: api/tools/index.md
          - Web Tools: api/tools/web.md
          - Code Execution: api/tools/code_backends.md
          - MCP: api/tools/mcp.md
          - View Image: api/tools/view-image.md
      - Utils:
          - Logging: api/utils/logging.md
          - Text: api/utils/text.md