opencode-python-sdk/mkdocs.yml at main · shrijayan/opencode-python-sdk · GitHub

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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
site_name: opencode-python-sdk
site_url: https://shrijayan.github.io/opencode-python-sdk/
site_description: Typed Python client for the OpenCode 2.x server API.
site_author: Shrijayan Rajendran
repo_url: https://github.com/shrijayan/opencode-python-sdk
repo_name: shrijayan/opencode-python-sdk
edit_uri: edit/main/docs/
copyright: MIT licensed. Unofficial and community-maintained; not affiliated with the OpenCode team.

exclude_docs: |
  design.html

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  icon:
    repo: fontawesome/brands/github
  font:
    text: IBM Plex Sans
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.tooltips

extra_css:
  - stylesheets/extra.css

hooks:
  - docs/hooks/types_reference.py

plugins:
  - search
  - social:
      enabled: !ENV [SOCIAL_CARDS, false]
      cards_layout_options:
        background_color: "#14110f"
        color: "#f4efe6"
        font_family: IBM Plex Sans
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            members_order: source
            merge_init_into_class: true
            filters: ["!^_"]
            show_if_no_docstring: true
            heading_level: 2

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
      toc_depth: 2
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/shrijayan/opencode-python-sdk
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/opencode-python-sdk/

nav:
  - Home: index.md
  - Getting started:
      - getting-started/index.md
      - Connect to a server: getting-started/connect.md
      - Run a server from Python: getting-started/server.md
      - Use the background service: getting-started/service.md
  - Guides:
      - guides/index.md
      - Sessions and prompts: guides/sessions.md
      - Running agents headless: guides/headless.md
      - Testing with the fake server: guides/testing.md
      - Async: guides/async.md
      - Models and unions: guides/models.md
      - Pagination: guides/pagination.md
      - Events and streaming: guides/events.md
      - Plugin RPC: guides/plugin-rpc.md
      - Interactive terminals: guides/terminals.md
      - Errors: guides/errors.md
      - Retries and timeouts: guides/retries.md
      - The project directory: guides/directory.md
      - Advanced httpx config: guides/httpx.md
      - Logging: guides/logging.md
  - API reference:
      - reference/index.md
      - Clients: reference/clients.md
      - Server launcher: reference/server.md
      - Background service: reference/service.md
      - Resources: reference/resources.md
      - Pagination and streams: reference/pagination.md
      - Shared events and RPC: reference/events.md
      - Terminals: reference/terminals.md
      - Exceptions: reference/exceptions.md
      - Helpers and testing: reference/testing.md
      - Types: reference/types/index.md
  - Project:
      - How it's built: project/how-its-built.md
      - Contributing: project/contributing.md
      - Versioning and releases: project/versioning.md
      - Security: project/security.md
      - Changelog: project/changelog.md