PyDotCompute/mkdocs.yml at main · mivertowski/PyDotCompute · 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
site_name: PyDotCompute
site_description: Python port of DotCompute's Ring Kernel System - GPU-native actor model
site_author: Michael Ivertowski
site_url: https://mivertowski.github.io/PyDotCompute/

repo_name: mivertowski/PyDotCompute
repo_url: https://github.com/mivertowski/PyDotCompute

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: google

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - First Ring Kernel: getting-started/first-kernel.md
  - Concepts:
    - articles/concepts/ring-kernels.md
    - articles/concepts/message-passing.md
    - articles/concepts/memory-management.md
    - articles/concepts/lifecycle.md
  - Guides:
    - articles/guides/building-actors.md
    - articles/guides/performance-tiers.md
    - articles/guides/pipelines.md
    - articles/guides/gpu-optimization.md
    - articles/guides/testing.md
  - Background:
    - articles/background/actor-model.md
    - articles/background/gpu-computing.md
    - articles/background/dotcompute-comparison.md
  - API Reference:
    - Overview: api/index.md
    - Core:
      - api/core/accelerator.md
      - api/core/unified-buffer.md
      - api/core/memory-pool.md
      - api/core/orchestrator.md
    - Ring Kernels:
      - api/ring-kernels/runtime.md
      - api/ring-kernels/message.md
      - api/ring-kernels/queue.md
      - api/ring-kernels/lifecycle.md
      - api/ring-kernels/telemetry.md
    - Backends:
      - api/backends/base.md
      - api/backends/cpu.md
      - api/backends/cuda.md
      - api/backends/metal.md
    - Decorators:
      - api/decorators/kernel.md
      - api/decorators/ring-kernel.md
      - api/decorators/validators.md
    - Exceptions: api/exceptions.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mivertowski/PyDotCompute

copyright: Copyright &copy; 2025 Michael Ivertowski