openarmature-python/mkdocs.yml at main · LunarCommand/openarmature-python · 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
site_name: OpenArmature
site_url: https://openarmature.ai/
site_description: Workflow framework for LLM pipelines and tool-calling agents
copyright: "©OpenArmature 2026"

# Local ``mkdocs serve`` binds here. Default 8000 was already in use
# on the maintainer's workstation; 8765 is the project convention.
dev_addr: "127.0.0.1:8765"

theme:
  name: material
  # Override directory for theme partials. ``docs/overrides/`` carries
  # the customized ``partials/header.html`` that makes the
  # "OpenArmature" wordmark clickable (Material's default leaves it
  # as a plain ``<div>``).
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.indexes
    - navigation.sections
    - navigation.tracking
    - navigation.footer
    - search.highlight
    - search.suggest
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
  - glightbox
  # /llms.txt + /llms-full.txt for AI coding assistants. Plain-text
  # versions of the docs that assistants can ingest in one shot —
  # matches the charter's "agent-friendly" framing.
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Getting Started:
          - getting-started/*.md
        Concepts:
          - concepts/*.md
        Patterns:
          - patterns/*.md
        Examples:
          - examples/*.md
        Model Providers:
          - model-providers/*.md
        Reference:
          - reference/*.md

markdown_extensions:
  - tables
  - toc:
      permalink: true
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - OpenArmature: index.md
  - Getting Started:
    - Quickstart: getting-started/index.md
  - Concepts:
    - concepts/index.md
    - State and reducers: concepts/state-and-reducers.md
    - Graphs: concepts/graphs.md
    - Composition: concepts/composition.md
    - Middleware: concepts/middleware.md
    - Fan-out: concepts/fan-out.md
    - Parallel branches: concepts/parallel-branches.md
    - LLMs: concepts/llms.md
    - Prompts: concepts/prompts.md
    - Observability: concepts/observability.md
    - Checkpointing: concepts/checkpointing.md
  - Patterns:
    - patterns/index.md
    - Parameterized entry point: patterns/parameterized-entry-point.md
    - Tool-dispatch-as-node: patterns/tool-dispatch-as-node.md
    - Session-as-checkpoint-resume: patterns/session-as-checkpoint-resume.md
    - Bypass-if-output-exists: patterns/bypass-if-output-exists.md
  - Examples:
    - examples/index.md
    - Hello, world: examples/00-hello-world.md
    - Routing and subgraphs: examples/01-routing-and-subgraphs.md
    - Explicit subgraph mapping: examples/02-explicit-subgraph-mapping.md
    - Observer hooks: examples/03-observer-hooks.md
    - Nested subgraphs: examples/04-nested-subgraphs.md
    - Fan-out with retry: examples/05-fan-out-with-retry.md
    - Parallel branches: examples/06-parallel-branches.md
    - Multimodal prompt: examples/07-multimodal-prompt.md
    - Checkpointing and migration: examples/08-checkpointing-and-migration.md
    - Tool use: examples/09-tool-use.md
  - Model Providers:
    - model-providers/index.md
    - Authoring a Provider: model-providers/authoring.md
  - Reference:
    - reference/index.md
    - openarmature.graph: reference/graph.md
    - openarmature.llm: reference/llm.md
    - openarmature.prompts: reference/prompts.md
    - openarmature.checkpoint: reference/checkpoint.md
    - openarmature.observability: reference/observability.md

extra:
  # Hide the "Made with Material for MkDocs" footer.
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/LunarCommand

extra_css:
  - stylesheets/extra.css