Switchyard/mkdocs.yml at main · NVIDIA-NeMo/Switchyard · 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
site_name: Switchyard
site_description: Typed, composable LLM routing and format translation for Python
repo_url: https://github.com/NVIDIA-NeMo/Switchyard
repo_name: NVIDIA-NeMo/Switchyard
edit_uri: edit/main/docs/
extra:
  source_ref: !ENV [MKDOCS_SOURCE_REF, main]
copyright: "Copyright &copy; 2025-2026 NVIDIA Corporation"

docs_dir: docs
site_dir: site
use_directory_urls: true
strict: true

hooks:
  - mkdocs_hooks.py

nav:
  - Home: index.md
  - Get Started:
      - Getting Started: getting_started.md
      - Known Issues: known_issues.md
  - Concepts:
      - Core Concepts: core_concepts.md
      - Architecture: architecture.md
  - Routing:
      - Overview: routing_algorithms/overview.md
      - Random Routing: routing_algorithms/random_routing.md
      - LLM Classifier Routing: routing_algorithms/llm_classifier_routing.md
      - Stage-Router Routing: routing_algorithms/stage_router_routing.md
      - Escalation-Router Routing: routing_algorithms/escalation_router_routing.md
  - Operations:
      - Context-Window Handling: operations/context_window.md
  - Reference:
      - CLI Reference: cli_reference.md
      - TOML Schema: reference/toml_schema.md
      - Rust API: reference/rust_api.md

exclude_docs: |
  internal/**
  research/**
  vllm-serve-hidden-state.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.top
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

plugins:
  - search:
      lang: en

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: [docs]
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: On this page
  - pymdownx.tasklist:
      custom_checkbox: true

extra_css:
  - stylesheets/nvidia.css