99 lines
2.6 KiB
YAML
99 lines
2.6 KiB
YAML
site_name: FastGPT Python SDK
|
|
site_description: Python SDK for FastGPT OpenAPI
|
|
site_author: FastGPT
|
|
repo_url: https://github.com/yourusername/fastgpt-python-sdk
|
|
repo_name: fastgpt-python-sdk
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- search.suggest
|
|
- search.highlight
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_style: google
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_root_members_full_path: false
|
|
show_object_full_path: false
|
|
show_signature_annotations: true
|
|
signature_crossrefs: true
|
|
merge_init_into_class: true
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- admonition
|
|
- pymdownx.details
|
|
- attr_list
|
|
- md_in_html
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/yourusername/fastgpt-python-sdk
|
|
- icon: fontawesome/solid/globe
|
|
link: https://doc.fastgpt.io/
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting_started/installation.md
|
|
- Quick Start: getting_started/quick_start.md
|
|
- Authentication: getting_started/authentication.md
|
|
- API Reference:
|
|
- Overview: api/overview.md
|
|
- ChatClient: api/chat_client.md
|
|
- AppClient: api/app_client.md
|
|
- Async Clients: api/async_clients.md
|
|
- Exceptions: api/exceptions.md
|
|
- Examples:
|
|
- Basic Usage: examples/basic_usage.md
|
|
- Streaming: examples/streaming.md
|
|
- Async Usage: examples/async_usage.md
|
|
- Chat Context: examples/chat_context.md
|
|
- Variables: examples/variables.md
|
|
- Advanced Topics:
|
|
- Error Handling: advanced/error_handling.md
|
|
- Streaming Events: advanced/streaming_events.md
|
|
- Rate Limiting: advanced/rate_limiting.md
|
|
- Detail Mode: advanced/detail_mode.md
|
|
- Development: development.md
|