forked from griptape-ai/griptape-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
131 lines (131 loc) · 5.29 KB
/
mkdocs.yml
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
site_name: Griptape Docs
plugins:
- glightbox
- search
- mkdocstrings:
handlers:
python:
paths: [griptape]
options:
show_if_no_docstring: true
heading_level: 3
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
copyright: "© Griptape, Inc."
extra_css:
- assets/css/extra.css
- assets/css/code_select.css
- assets/css/mkdocstrings.css
extra:
analytics:
provider: google
property: G-QM8EDPSCB6
social:
- icon: fontawesome/solid/house
link: https://www.griptape.ai
- icon: fontawesome/brands/discord
link: https://discord.gg/gnWRz88eym
- icon: fontawesome/brands/github
link: https://github.com/griptape-ai/griptape/
- icon: fontawesome/brands/python
link: https://pypi.org/project/griptape/
theme:
name: material
custom_dir: docs/overrides
logo: assets/img/griptape-mark-square-light.svg
palette:
scheme: slate
primary: black
accent: deep orange
features:
- content.code.copy
- content.code.annotate
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- announce.dismiss
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed
- tables
- def_list
- footnotes
nav:
- Home:
- Overview: "index.md"
- Contributing: "contributing.md"
- Griptape Framework:
- Overview: "griptape-framework/index.md"
- Structures:
- Tasks: "griptape-framework/structures/tasks.md"
- Agents: "griptape-framework/structures/agents.md"
- Pipelines: "griptape-framework/structures/pipelines.md"
- Workflows: "griptape-framework/structures/workflows.md"
- Prompt Drivers: "griptape-framework/structures/prompt-drivers.md"
- Conversation Memory: "griptape-framework/structures/conversation-memory.md"
- Rulesets: "griptape-framework/structures/rulesets.md"
- Events: "griptape-framework/structures/events.md"
- Tools:
- Overview: "griptape-framework/tools/index.md"
- Tool Memory: "griptape-framework/tools/tool-memory.md"
- Building Custom Tools: "griptape-tools/custom-tools/index.md"
- Data:
- Overview: "griptape-framework/data/index.md"
- Artifacts: "griptape-framework/data/artifacts.md"
- Embedding Drivers: "griptape-framework/data/embedding-drivers.md"
- Chunkers: "griptape-framework/data/chunkers.md"
- Loaders: "griptape-framework/data/loaders.md"
- Extraction Engines: "griptape-framework/data/extraction-engines.md"
- Query Engines: "griptape-framework/data/query-engines.md"
- Summary Engines: "griptape-framework/data/summary-engines.md"
- Vector Store Drivers: "griptape-framework/data/vector-store-drivers.md"
- SQL Drivers: "griptape-framework/data/sql-drivers.md"
- Griptape Tools:
- Overview: "griptape-tools/index.md"
- Official Tools:
- AwsIamClient: "griptape-tools/official-tools/aws-iam-client.md"
- AwsS3Client: "griptape-tools/official-tools/aws-s3-client.md"
- Calculator: "griptape-tools/official-tools/calculator.md"
- Computer: "griptape-tools/official-tools/computer.md"
- DateTime: "griptape-tools/official-tools/date-time.md"
- EmailClient: "griptape-tools/official-tools/email-client.md"
- FileManager: "griptape-tools/official-tools/file-manager.md"
- GoogleCalendarClient: "griptape-tools/official-tools/google-cal-client.md"
- GoogleGmailClient: "griptape-tools/official-tools/google-gmail-client.md"
- GoogleDriveClient: "griptape-tools/official-tools/google-drive-client.md"
- GoogleDocsClient: "griptape-tools/official-tools/google-docs-client.md"
- OpenWeatherClient: "griptape-tools/official-tools/openweather-client.md"
- ProxycurlClient: "griptape-tools/official-tools/proxycurl-client.md"
- RestApiClient: "griptape-tools/official-tools/rest-api-client.md"
- SqlClient: "griptape-tools/official-tools/sql-client.md"
- ToolOutputProcessor: "griptape-tools/official-tools/tool-output-processor.md"
- VectorStoreClient: "griptape-tools/official-tools/vector-store-client.md"
- WebScraper: "griptape-tools/official-tools/web-scraper.md"
- WebSearch: "griptape-tools/official-tools/web-search.md"
- Custom Tools:
- Building Custom Tools: "griptape-tools/custom-tools/index.md"
- Griptape Recipes:
- Overview: "examples/index.md"
- Agents:
- Talk to Redshift: "examples/talk-to-redshift.md"
- Talk to a Webpage: "examples/talk-to-a-webpage.md"
- Talk to a PDF: "examples/talk-to-a-pdf.md"
- Data:
- Load and Query Pinecone: "examples/load-and-query-pinecone.md"
- Load and Query Marqo: "examples/load-query-and-chat-marqo.md"
- Query a Webpage: "examples/query-webpage.md"
- Griptape Reference Guide: "reference/"
- Griptape Trade School: "https://learn.griptape.ai"