dimos/mkdocs.yml at main · dimensionalOS/dimos · 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
site_name: Dimensional
site_description: >-
  Official documentation for Dimensional (dimOS) — the modern operating system
  for generalist robotics: Python-first, agent-native, and hardware-agnostic.
site_url: https://docs.dimensional.org/
repo_url: https://github.com/dimensionalOS/dimos
repo_name: dimensionalOS/dimos
edit_uri: edit/main/docs/
copyright: Dimensional Inc.

docs_dir: docs
site_dir: site

# docs/ is a workspace as well as a page tree; keep the non-pages out.
exclude_docs: |
  node_modules/
  .gitattributes
  logs/
  todo.md
  # agent instructions, not pages
  CLAUDE.md
  # artifacts the executable docs drop next to the page they belong to
  *.db
  *.rrd
  *.mcap
  bla*
  None

# Repo-root links and md-babel fence params are translated at build time,
# so every page under docs/ stays exactly as it is on github.
hooks:
  - misc/mkdocs/hooks.py

# mkdocs serve watches docs/ and the config; the theme lives outside both.
watch:
  - misc/mkdocs

theme:
  name: material
  custom_dir: misc/mkdocs/overrides
  static_templates:
    - llms.txt
  favicon: assets/favicon.png
  logo: assets/dimensional-logo-master-transparent.png
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  # Dark only: one palette entry means material renders no toggle.
  palette:
    scheme: slate
    primary: custom
    accent: custom

extra_css:
  - assets/mkdocs-theme.css

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

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            allow_inspection: false
            docstring_style: google
            docstring_options:
              warn_missing_types: false
            show_signature_annotations: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_docstring_attributes: true
  # nav lives in docs/.nav.yml (and per-directory .nav.yml files)
  - awesome-nav
  # click a diagram or screenshot to open it full size
  - glightbox:
      auto_caption: false
      skip_classes: [no-lightbox]
  - minify:
      minify_html: true