python-sdk/mkdocs.yml at master · ai-agent-assembly/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
# Project information
site_name: Agent Assembly Python SDK
site_url: https://ai-agent-assembly.github.io/python-sdk/
site_author: Agent Assembly Team
site_description: >-
  Python SDK for AI Agent Assembly — a governance-native runtime for AI agents.
  Wire framework adapters, enforce policy on tool calls, and emit audit events
  with one init_assembly() call.

# Repository
repo_name: AI-agent-assembly/python-sdk
repo_url: https://github.com/AI-agent-assembly/python-sdk
edit_uri: edit/master/docs/

# Copyright
copyright: Copyright &copy; 2026 Agent Assembly Team

theme:
  name: material
  custom_dir: ./docs/_overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  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
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: material/library

# Plugins
plugins:
  # Doc-as-Code — render Python API reference inline from package docstrings.
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: spacy
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            relative_crossrefs: true
            show_source: true
            show_signature_annotations: true
            separate_signature: true
  # Versioning documentation — every master push deploys to "latest", releases promote to "stable".
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  # Documentation modification info — per-page "last updated" timestamp.
  - git-revision-date-localized:
      type: timeago
      timezone: Asia/Taipei
      fallback_to_build_date: false
      enable_creation_date: true
      enable_git_follow: true
      enabled: true
      strict: true
  # Documentation modification info — per-page contributor list.
  - git-committers:
      repository: AI-agent-assembly/python-sdk
      branch: master

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: AI-agent-assembly
      repo: python-sdk
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Additional configuration
extra:
  # Versioning documentation
  version:
    provider: mike
    default: stable
    alias: true
  # Social info
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AI-agent-assembly/python-sdk
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/agent-assembly/

# Page tree
nav:
  - Home: index.md
  - Architecture:
      - architecture/index.md
  - API reference:
      - api-reference/index.md
      - Client: api-reference/client.md
      - Exceptions: api-reference/exceptions.md
      - Models: api-reference/models.md
  - Development:
      - development/index.md
      - ADR:
          - 0001 — Hook architecture: development/adr/0001-hook-architecture.md
  - Release notes:
      - release-notes/index.md