griptape

mkdocs.yml
165 строк · 7.4 Кб
Перенос по словам
1
site_name: Griptape Docs
2
hooks:
3
  - docs/plugins/swagger_ui_plugin.py
4
plugins:
5
  - glightbox
6
  - search
7
  - mkdocstrings:
8
      handlers:
9
        python:
10
          paths: ["griptape"]
11
          options:
12
            show_if_no_docstring: true
13
            heading_level: 3
14
  - gen-files:
15
      scripts:
16
        - docs/gen_ref_pages.py
17
  - literate-nav:
18
      nav_file: SUMMARY.md
19
  - section-index
20
copyright: "&copy; Griptape, Inc."
21
extra_css:
22
  - assets/css/extra.css
23
  - assets/css/code_select.css
24
  - assets/css/mkdocstrings.css
25
  - assets/css/swagger-ui.css
26
extra_javascript:
27
  - assets/scripts/swagger-ui-bundle.js
28
  - assets/scripts/swagger-ui-standalone-preset.js
29
extra:
30
  analytics:
31
    provider: google
32
    property: G-QM8EDPSCB6
33
  social:
34
    - icon: fontawesome/solid/house
35
      link: https://www.griptape.ai
36
    - icon: fontawesome/brands/discord
37
      link: https://discord.gg/gnWRz88eym
38
    - icon: fontawesome/brands/github
39
      link: https://github.com/griptape-ai/griptape/
40
    - icon: fontawesome/brands/python
41
      link: https://pypi.org/project/griptape/
42
theme:
43
  name: material
44
  custom_dir: docs/overrides
45
  logo: assets/img/griptape-mark-square-light.svg
46
  palette:
47
    scheme: slate
48
    primary: black
49
    accent: deep orange
50
  features:
51
    - content.code.copy
52
    - content.code.annotate
53
    - navigation.tabs
54
    - navigation.sections
55
    - navigation.expand
56
    - navigation.top
57
    - announce.dismiss
58
    - toc.follow
59
markdown_extensions:
60
  - pymdownx.highlight:
61
      anchor_linenums: true
62
      line_spans: __span
63
      pygments_lang_class: true
64
  - admonition
65
  - pymdownx.inlinehilite
66
  - pymdownx.snippets
67
  - pymdownx.superfences
68
  - pymdownx.details
69
  - pymdownx.tabbed
70
  - tables
71
  - def_list
72
  - footnotes
73
nav:
74
  - Home:
75
      - Overview: "index.md"
76
      - Contributing: "contributing.md"
77
  - Cloud:
78
      - Cloud API:
79
          - API Reference: "griptape-cloud/api/api-reference.md"
80
  - Framework:
81
      - Overview: "griptape-framework/index.md"
82
      - Structures:
83
          - Agents: "griptape-framework/structures/agents.md"
84
          - Pipelines: "griptape-framework/structures/pipelines.md"
85
          - Workflows: "griptape-framework/structures/workflows.md"
86
          - Tasks: "griptape-framework/structures/tasks.md"
87
          - Task Memory: "griptape-framework/structures/task-memory.md"
88
          - Conversation Memory: "griptape-framework/structures/conversation-memory.md"
89
          - Rulesets: "griptape-framework/structures/rulesets.md"
90
          - Config: "griptape-framework/structures/config.md"
91
      - Tools:
92
          - Overview: "griptape-framework/tools/index.md"
93
          - Building Custom Tools: "griptape-tools/custom-tools/index.md"
94
      - Engines:
95
          - Query Engines: "griptape-framework/engines/query-engines.md"
96
          - Extraction Engines: "griptape-framework/engines/extraction-engines.md"
97
          - Summary Engines: "griptape-framework/engines/summary-engines.md"
98
          - Image Generation Engines: "griptape-framework/engines/image-generation-engines.md"
99
          - Image Query Engines: "griptape-framework/engines/image-query-engines.md"
100
          - Audio Engines: "griptape-framework/engines/audio-engines.md"
101
      - Drivers:
102
          - Prompt Drivers: "griptape-framework/drivers/prompt-drivers.md"
103
          - Embedding Drivers: "griptape-framework/drivers/embedding-drivers.md"
104
          - Vector Store Drivers: "griptape-framework/drivers/vector-store-drivers.md"
105
          - Image Generation Drivers: "griptape-framework/drivers/image-generation-drivers.md"
106
          - SQL Drivers: "griptape-framework/drivers/sql-drivers.md"
107
          - Image Query Drivers: "griptape-framework/drivers/image-query-drivers.md"
108
          - Web Scraper Drivers: "griptape-framework/drivers/web-scraper-drivers.md"
109
          - Conversation Memory Drivers: "griptape-framework/drivers/conversation-memory-drivers.md"
110
          - Event Listener Drivers: "griptape-framework/drivers/event-listener-drivers.md"
111
          - Structure Run Drivers: "griptape-framework/drivers/structure-run-drivers.md"
112
          - Text to Speech Drivers: "griptape-framework/drivers/text-to-speech-drivers.md"
113
      - Data:
114
          - Overview: "griptape-framework/data/index.md"
115
          - Artifacts: "griptape-framework/data/artifacts.md"
116
          - Chunkers: "griptape-framework/data/chunkers.md"
117
          - Loaders: "griptape-framework/data/loaders.md"
118
      - Misc:
119
          - Events: "griptape-framework/misc/events.md"
120
          - Tokenizers: "griptape-framework/misc/tokenizers.md"
121
  - Tools:
122
      - Overview: "griptape-tools/index.md"
123
      - Official Tools:
124
          - AwsIamClient: "griptape-tools/official-tools/aws-iam-client.md"
125
          - AwsS3Client: "griptape-tools/official-tools/aws-s3-client.md"
126
          - Calculator: "griptape-tools/official-tools/calculator.md"
127
          - Computer: "griptape-tools/official-tools/computer.md"
128
          - DateTime: "griptape-tools/official-tools/date-time.md"
129
          - EmailClient: "griptape-tools/official-tools/email-client.md"
130
          - FileManager: "griptape-tools/official-tools/file-manager.md"
131
          - GoogleCalendarClient: "griptape-tools/official-tools/google-cal-client.md"
132
          - GoogleGmailClient: "griptape-tools/official-tools/google-gmail-client.md"
133
          - GoogleDriveClient: "griptape-tools/official-tools/google-drive-client.md"
134
          - GoogleDocsClient: "griptape-tools/official-tools/google-docs-client.md"
135
          - StructureRunClient: "griptape-tools/official-tools/structure-run-client.md"
136
          - OpenWeatherClient: "griptape-tools/official-tools/openweather-client.md"
137
          - RestApiClient: "griptape-tools/official-tools/rest-api-client.md"
138
          - SqlClient: "griptape-tools/official-tools/sql-client.md"
139
          - TaskMemoryClient: "griptape-tools/official-tools/task-memory-client.md"
140
          - VectorStoreClient: "griptape-tools/official-tools/vector-store-client.md"
141
          - WebScraper: "griptape-tools/official-tools/web-scraper.md"
142
          - WebSearch: "griptape-tools/official-tools/web-search.md"
143
          - PromptImageGenerationClient: "griptape-tools/official-tools/prompt-image-generation-client.md"
144
          - VariationImageGenerationClient: "griptape-tools/official-tools/variation-image-generation-client.md"
145
          - InpaintingImageGenerationClient: "griptape-tools/official-tools/inpainting-image-generation-client.md"
146
          - OutpaintingImageGenerationClient: "griptape-tools/official-tools/outpainting-image-generation-client.md"
147
          - ImageQueryClient: "griptape-tools/official-tools/image-query-client.md"
148
          - TextToSpeechClient: "griptape-tools/official-tools/text-to-speech-client.md"
149
      - Custom Tools:
150
          - Building Custom Tools: "griptape-tools/custom-tools/index.md"
151
  - Recipes:
152
      - Overview: "examples/index.md"
153
      - Agents:
154
          - Talk to Redshift: "examples/talk-to-redshift.md"
155
          - Talk to a Webpage: "examples/talk-to-a-webpage.md"
156
          - Talk to a PDF: "examples/talk-to-a-pdf.md"
157
          - Multi Agent Workflows: "examples/multi-agent-workflow.md"
158
          - Shared Memory Between Agents: "examples/multiple-agent-shared-memory.md"
159
          - Chat Sessions with Amazon DynamoDB: "examples/amazon-dynamodb-sessions.md"
160
      - Data:
161
          - Load and Query Pinecone: "examples/load-and-query-pinecone.md"
162
          - Load and Query Marqo: "examples/load-query-and-chat-marqo.md"
163
          - Query a Webpage: "examples/query-webpage.md"
164
  - Reference Guide: "reference/"
165
  - Trade School: "https://learn.griptape.ai"
166
griptape

Использование cookies
