-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
237 lines (228 loc) · 9.69 KB
/
Copy pathmkdocs.yml
File metadata and controls
237 lines (228 loc) · 9.69 KB
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
site_name: AnyInfer
site_description: >-
AnyInfer provides an application-owned hybrid inference runtime for Python,
spanning hosted APIs, routing hubs, existing local services, and supervised
llama.cpp, as well as the typed contract that makes them behave alike.
site_url: https://anyinfer.dev/
repo_url: https://github.com/anthturner/AnyInfer
repo_name: anthturner/AnyInfer
edit_uri: edit/main/docs/
# docs/README.md is the table of contents GitHub renders when browsing the repo; the
# published site has its own landing page (index.md) and navigation, so the TOC page is
# excluded rather than duplicated. The leading slash anchors the pattern to docs/ itself —
# the per-section README.md files below it are the site's section indexes and must stay.
exclude_docs: |
/README.md
# The downloads page is deliberately outside the nav: it is reached from the header's
# "Download vX.Y.Z" button (overrides/partials/header.html) and from the landing page.
# Keeping it out of the nav keeps Home a single page, so the mobile drawer opens on the
# full top-level navigation instead of drilling into a two-item "Home" section.
not_in_nav: |
/downloads.md
# `mkdocs serve` only watches docs_dir and this config file by default, so template
# edits under custom_dir (overrides/) never trigger a rebuild without this — a stale
# dev server keeps serving old template output indefinitely, which looks identical to
# a real bug from the browser.
watch:
- overrides
theme:
name: material
# Template overrides: main.html (link-preview and icon tags in <head>), home.html and
# 404.html (custom layouts), and partials/header.html (the download button).
# Re-sync those copies when bumping the mkdocs-material pin.
custom_dir: overrides
# The icon art is background-independent (see docs/assets/anyinfer-palette.css), so one
# header logo serves both schemes; the wordmark SVGs on the landing page and README
# are the theme-swapped pair.
logo: assets/anyinfer-icon-512.svg
favicon: assets/anyinfer-icon-512.png
font:
text: Inter
code: JetBrains Mono
palette:
# Brand colors are defined in stylesheets/extra.css against these custom schemes.
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.indexes
- search.suggest
- search.highlight
- content.code.copy
- content.action.edit
extra_css:
- stylesheets/extra.css
- stylesheets/home.css
# Build hooks. mkdocs_hooks.py feeds the header download button the version from
# pyproject.toml, so the button never drifts from the release it points at.
hooks:
- scripts/mkdocs_hooks.py
markdown_extensions:
- admonition
- attr_list
- md_in_html
- toc:
permalink: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
# Pages merged away in the 2026-08 reorganization keep their old URLs through
# static stubs written by scripts/mkdocs_hooks.py (see REDIRECTS there) — the
# hook approach adds no plugin dependency to the docs build.
- mkdocstrings:
handlers:
python:
paths: [src]
options:
docstring_style: google
members_order: source
show_root_heading: true
show_source: false
separate_signature: true
show_signature_annotations: true
merge_init_into_class: true
inherited_members: false
nav:
- Home: index.md
- Integrate:
- guides/README.md
- Quickstart: guides/quickstart.md
- Installation and Extras: guides/installation.md
- Why and When to Use AnyInfer: why-anyinfer.md
- Shared Configuration: reference/configuration.md
- Surfaces:
- Integrate the Python SDK: guides/python-sdk.md
- Run a Prompt from the Shell: guides/cli.md
- OpenAI-Compatible Sidecar: serve/README.md
- Running the Sidecar as a Service: serve/running-as-a-service.md
- Python Tasks:
- Stream Typed Events: guides/streaming.md
- Enforce a JSON Schema: guides/structured-output.md
- Add a Fallback Chain: guides/fallback.md
- Run the Tool Loop: guides/tool-loop.md
- Fit a Corpus to a Budget: guides/fitting-context.md
- Test Your Application Offline: guides/testing-your-app.md
- Compare Targets Without Spending: guides/comparing-targets.md
- Add Your Own Provider: guides/custom-providers.md
- Embed, Store, and Query Without a Database: guides/vector-store.md
- Operations:
- Run a Model Locally: guides/local-inference.md
- Observability: guides/observability.md
- Confidentiality Tiers: guides/confidentiality-tiers.md
- Coding Agents: guides/coding-agents.md
- Integration Procedure: agents/INTEGRATION.md
- The Pack-In Demo Application: guides/demo-app.md
- Concepts:
- concepts/README.md
- The Request Path:
- Targets and Aliases: concepts/targets.md
- The Event Stream: concepts/events.md
- Routing and Rate Limits: concepts/routing.md
- Structured Output: concepts/structured-output.md
- Sessions: concepts/sessions.md
- Embeddings and Reranking: concepts/embeddings.md
- Multimodal Inputs: concepts/multimodal-inputs.md
- Cost and Context:
- Capabilities and Provenance: concepts/capabilities.md
- Token Estimation and Context Budgets: concepts/budgeting.md
- Cost and Spending: concepts/cost.md
- Prompt Caching: concepts/caching.md
- Context Reduction: concepts/context-reduction.md
- Local Execution:
- The Local Subsystem: concepts/local.md
- The Model Catalog: concepts/catalog.md
- Operations:
- Credentials and Redaction: concepts/credentials.md
- Telemetry: concepts/telemetry.md
- Run Manifests: concepts/run-manifests.md
- Arena Runs: concepts/arena.md
- Examples:
- examples/README.md
- Structured Summaries with Fallback: examples/summarize-with-fallback.md
- A Local Tool-Calling Assistant: examples/local-tool-agent.md
- Distill a Corpus: examples/distill-a-corpus.md
- Regression-Test Fallback and Repair: examples/golden-manifest.md
- Semantic Search over a Small Corpus: examples/semantic-search.md
- Providers:
- providers/README.md
- Every Provider: providers/all.md
- Hosted & Local Presets: providers/presets.md
- OpenAI: providers/openai.md
- Anthropic: providers/anthropic.md
- Google Gemini: providers/gemini.md
- DeepSeek: providers/deepseek.md
- xAI (Grok): providers/xai.md
- Google Vertex AI: providers/vertex.md
- AWS Bedrock: providers/bedrock.md
- Cohere: providers/cohere.md
- Azure AI Foundry: providers/azure-foundry.md
- GitHub Copilot: providers/copilot.md
- Microsoft 365 Copilot: providers/m365-copilot.md
- OpenRouter: providers/openrouter.md
- Nebius Token Factory: providers/nebius.md
- Ollama: providers/ollama.md
- LM Studio: providers/lm-studio.md
- llama.cpp: providers/llama-cpp.md
- Text Embeddings Inference: providers/tei.md
- Voyage AI and Jina AI: providers/retrieval.md
- OpenAI-Compatible: providers/openai-compat.md
- Reference:
- reference/README.md
- SDK Reference:
- reference/api/README.md
- Clients and Streams: reference/api/client.md
- Requests and Messages: reference/api/requests.md
- Results and Stream Events: reference/api/results.md
- Embeddings and Reranking: reference/api/embeddings.md
- Portability Diff Tool: reference/api/compare-diff.md
- Vector Store Add-On: reference/api/vector-store.md
- Confidentiality Add-Ons: reference/api/confidential.md
- Routing: reference/api/routing.md
- Capabilities: reference/api/capabilities.md
- Context Reduction: reference/api/context.md
- Telemetry and Redaction: reference/api/telemetry.md
- Registry, Catalog, Credentials: reference/api/registry.md
- Configuration: reference/api/configuration.md
- Local Inference: reference/api/local.md
- Sidecar Frontend: reference/api/serve.md
- Testing Utilities: reference/api/testing.md
- Errors: reference/api/errors.md
- Error Catalog: reference/errors.md
- Conformance Matrix: reference/conformance-matrix.md
- Glossary: reference/glossary.md
- Contributing:
- contributing/README.md
- Architecture: contributing/architecture.md
- Coding Agents and Workstreams: contributing/automation.md
- Branding and Visual Assets: contributing/branding.md
- Writing an Adapter: contributing/writing-an-adapter.md
- The Conformance Suite: contributing/conformance.md
- Testing: contributing/testing.md
- Branching and Releases: contributing/releasing.md
- The Changelog: contributing/changelog.md