digitalkin/mkdocs.yml at main · DigitalKin-ai/digitalkin · 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
site_name: DigitalKin
site_description: A modular framework for building AI agents with gRPC servers and flexible service strategies
docs_dir: docs
site_url: https://digitalkin.com
repo_url: https://github.com/DigitalKin-ai/digitalkin
repo_name: DigitalKin-ai/digitalkin
site_dir: "site"
watch: [mkdocs.yml, README.md, src]
copyright: Copyright &copy; 2025 Digitalkin
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.instant.preview
  - navigation.path
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference

markdown_extensions:
- abbr
- attr_list
- admonition
- callouts:
    strip_period: no
- footnotes
- md_in_html
- pymdownx.blocks.admonition
- pymdownx.blocks.details
- pymdownx.blocks.tab:
    alternate_style: true
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
    pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.snippets:
    base_path: [!relative $config_dir]
    check_paths: true
- 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
- toc:
    permalink: "¤"

plugins:
- search
- mike
- autorefs
- markdown-exec
- section-index
# - coverage
- mkdocstrings:
    handlers:
      python:
        paths: [src, docs/snippets]
        inventories:
        - https://docs.python.org/3/objects.inv
        - https://mkdocstrings.github.io/objects.inv
        - https://mkdocstrings.github.io/autorefs/objects.inv
        - https://mkdocstrings.github.io/griffe/objects.inv
        - https://python-markdown.github.io/objects.inv
        options:
          backlinks: tree
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: list
          filters: public
          heading_level: 1
          inherited_members: true
          line_length: 88
          merge_init_into_class: true
          parameter_headings: true
          type_parameter_headings: true
          preload_modules: [mkdocstrings]
          relative_crossrefs: true
          scoped_crossrefs: true
          separate_signature: true
          show_bases: false
          show_inheritance_diagram: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_signature_type_parameters: true
          show_source: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true
          unwrap_annotated: true
- llmstxt:
    full_output: llms-full.txt
    sections:
      Usage:
      - index.md
      API:
      - api/api.md
- git-revision-date-localized:
    enabled: !ENV [DEPLOY, false]
    enable_creation_date: true
    type: timeago
- minify:
    minify_html: !ENV [DEPLOY, false]
- redirects:
    redirect_maps:
      reference/mkdocstrings_handlers/python/index.md: api/api.md
      reference/mkdocstrings_handlers/python/config.md: api/api.md#mkdocstrings_handlers.python.config
      reference/mkdocstrings_handlers/python/debug.md: api/api.md#mkdocstrings_handlers.python.debug
      reference/mkdocstrings_handlers/python/handler.md: api/api.md#mkdocstrings_handlers.python.handler
      reference/mkdocstrings_handlers/python/rendering.md: api/api.md#mkdocstrings_handlers.python.rendering

- group:
    enabled: !ENV [MATERIAL_INSIDERS, false]
    plugins:
    - typeset

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/digitalkin-ai
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/digitalkin/

  version:
    provider: mike
    default: stable