openai/chatkit-python
Publicmirrored fromhttps://github.com/openai/chatkit-pythonAvailable
mkdocs.yml
95lines · modecode
| 1 | site_name: Chatkit Python SDK |
| 2 | theme: |
| 3 | name: material |
| 4 | features: |
| 5 | - content.code.copy |
| 6 | - content.code.select |
| 7 | - navigation.sections |
| 8 | - navigation.path |
| 9 | - navigation.expand |
| 10 | - content.code.annotate |
| 11 | palette: |
| 12 | primary: black |
| 13 | logo: assets/logo.svg |
| 14 | favicon: images/favicon-platform.svg |
| 15 | |
| 16 | repo_name: chatkit-python |
| 17 | repo_url: https://github.com/openai/chatkit-python |
| 18 | |
| 19 | plugins: |
| 20 | - search |
| 21 | - mkdocstrings: |
| 22 | handlers: |
| 23 | python: |
| 24 | paths: ["."] |
| 25 | selection: |
| 26 | docstring_style: google |
| 27 | options: |
| 28 | signature_crossrefs: true |
| 29 | members_order: source |
| 30 | separate_signature: true |
| 31 | show_signature_annotations: true |
| 32 | heading_level: 3 |
| 33 | inherited_members: false |
| 34 | filters: |
| 35 | - "!^_" |
| 36 | - gen-files: |
| 37 | scripts: |
| 38 | - docs/gen_ref_pages.py |
| 39 | |
| 40 | nav: |
| 41 | - Home: index.md |
| 42 | - Guides: |
| 43 | - Serve ChatKit from your backend: guides/serve-chatkit.md |
| 44 | - Persist ChatKit threads and messages: guides/persist-chatkit-data.md |
| 45 | - Convert user input to model input: guides/convert-user-input.md |
| 46 | - Run inference: guides/run-inference.md |
| 47 | - Stream responses back to your user: guides/stream-thread-events.md |
| 48 | - Add features: |
| 49 | - Save thread titles: guides/add-features/save-thread-titles.md |
| 50 | - Accept attachments: guides/add-features/accept-attachments.md |
| 51 | - Make client tool calls: guides/add-features/make-client-tool-calls.md |
| 52 | - Send client effects: guides/add-features/send-client-effects.md |
| 53 | - Show progress for long-running tools: guides/add-features/show-progress-for-long-running-tools.md |
| 54 | - Stream widgets: guides/add-features/stream-widgets.md |
| 55 | - Handle widget actions: guides/add-features/handle-widget-actions.md |
| 56 | - Create custom forms: guides/add-features/create-custom-forms.md |
| 57 | - Handle feedback: guides/add-features/handle-feedback.md |
| 58 | - Allow @-mentions in user messages: guides/add-features/allow-mentions.md |
| 59 | - Add annotations in assistant messages: guides/add-features/add-annotations.md |
| 60 | - Disable new messages for a thread: guides/add-features/disable-new-messages.md |
| 61 | - API Reference: |
| 62 | - Overview: api/chatkit/index.md |
| 63 | - Modules: |
| 64 | - actions: api/chatkit/actions.md |
| 65 | - agents: api/chatkit/agents.md |
| 66 | - errors: api/chatkit/errors.md |
| 67 | - server: api/chatkit/server.md |
| 68 | - store: api/chatkit/store.md |
| 69 | - types: api/chatkit/types.md |
| 70 | - widgets: api/chatkit/widgets.md |
| 71 | - Release process / changelog: release.md |
| 72 | - ChatKit JS Docs: https://openai.github.io/chatkit-js/ |
| 73 | markdown_extensions: |
| 74 | - pymdownx.superfences: |
| 75 | custom_fences: |
| 76 | - name: mermaid |
| 77 | class: mermaid |
| 78 | format: !!python/name:pymdownx.superfences.fence_code_format |
| 79 | - admonition |
| 80 | - attr_list |
| 81 | - md_in_html |
| 82 | - pymdownx.details |
| 83 | - pymdownx.highlight: |
| 84 | anchor_linenums: true |
| 85 | line_spans: __span |
| 86 | pygments_lang_class: true |
| 87 | - pymdownx.inlinehilite |
| 88 | - pymdownx.snippets |
| 89 | - pymdownx.superfences |
| 90 | |
| 91 | extra_css: |
| 92 | - stylesheets/extra.css |
| 93 | |
| 94 | watch: |
| 95 | - chatkit |
| 96 | |