Files
instructor/mkdocs.yml
T
2023-07-10 00:42:24 +08:00

56 lines
1.6 KiB
YAML

site_name: OpenAI Function Call Library
site_description: Enhancing OpenAI function calling with Pydantic
repo_name: openai_function_call
repo_url: https://github.com/jxnl/openai_function_call
site_url: https://openai-function-call.onrender.com/
theme:
name: material
icon:
repo: fontawesome/brands/github
features:
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.expand
- content.code.annotate
plugins:
- social
- mkdocstrings:
handlers:
python:
options:
members_order: alphabetical
allow_inspection: true
show_bases: true
markdown_extensions:
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- attr_list
- md_in_html
- admonition
nav:
- Quick Start: 'index.md'
- API Reference:
- 'OpenAISchema': 'openai_schema.md'
- "MultiTask Schema": "multitask.md"
- "Introduction: Pipeline API": "pipeline-example.md"
- "Message Templates": "chat-completion.md"
- Use Cases:
- 'Overview': 'examples/index.md'
- 'Segmented Search': 'examples/search.md'
- 'One shot Query Planning': 'examples/planning-tasks.md'
- 'Recursive Schemas': 'examples/recursive.md'
- 'Exact Citations': 'examples/exact_citations.md'
- 'Automated Dataframe Extraction': "examples/autodataframe.md"
- Philosophy: 'philosophy.md'