runner/mkdocs.yml at main · waldiez/runner · 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
---
site_name: Waldiez Runner
site_url: https://waldiez.github.io/runner/
repo_name: waldiez/runner
repo_url: https://github.com/waldiez/runner
edit_uri_template: "blob/main/docs/{path}"
copyright: >
  Copyright &copy; 2026 Waldiez & Contributors

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: custom-light
      accent: blue
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom-dark
      accent: blue
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    # - announce.dismiss
    # - content.action.edit
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    # - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - toc.follow
  icon:
    repo: material/git
  logo: static/images/logo.svg
  favicon: static/favicon.ico
  include_sidebar: false

markdown_extensions:
  - toc:
      permalink: true
      baselevel: 2
  - markdown.extensions.codehilite:
      guess_lang: false
  - admonition
  - codehilite
  - extra
  - mdx_truly_sane_lists
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - mdx_include:
      base_path: docs
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          # yamllint disable
          # fmt: off
          format: !!python/name:pymdownx.superfences.fence_code_format
          # fmt: on
          # yamllint enable # fmt: skip

extra_css:
  - static/css/main.css
  - static/css/mkdocsoad.css

plugins:
  - search:
      lang: en
  - mermaid2:
      javascript: static/js/mermaid.min.js
      arguments:
        securityLevel: "loose"
  - minify_html
  - macros
  - autorefs
  - privacy
  - offline
  - mkdocs-jupyter
  - neoteroi.mkdocsoad:
      use_pymdownx: true
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths: [.]
          import:
            - url: https://docs.python.org/3/objects.inv
              domains: [std, py]
            - https://typing-extensions.readthedocs.io/en/latest/objects.inv
          options:
            filters:
              - "!^_"
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            docstring_style: numpy
            show_submodules: true
            show_root_heading: false
            show_signature_annotations: true
            show_signature: true
            signature_crossrefs: true
            show_source: true
            group_by_category: false
            show_category_heading: true
            inherited_members: false
            separate_signature: true

# yamllint disable
nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Architecture: architecture.md
  - Usage:
      - Clients & Authentication: clients.md
      - Tasks: tasks.md
      - WebSocket: websocket.md
      - Configuration: config.md
      - Examples:
          - Overview: examples/index.md
          # - React + TS Demo: examples/react.md
          - HTML + JS (Vanilla): examples/html.md
          - Task Demo (Jupyter Notebook): examples/task_demo.ipynb
          - Streamlit Demo: examples/streamlit.md

  # - Deployment:
  #     - Docker / Compose: deployment/docker.md
  #     - Kubernetes (WIP): deployment/k8s.md
  #     - System Requirements: deployment/system.md

  # - Contributing:
  #     - Overview: contributing/index.md
  #     - Dev Setup & Commands: contributing/dev.md
  #     - VS Code DevContainer: contributing/devcontainer.md
  #     - Style Guide: contributing/style.md
  #     - Testing & Coverage: contributing/testing.md
  #     - Docs / MkDocs Guide: contributing/docs.md

  - Reference:
      - Client: reference/client.md
      - OpenAPI Docs: reference/openapi.md
# yamllint enable

not_in_nav: |
  examples/app.py