agentic-api/mkdocs.yaml at main · EmbeddedLLM/agentic-api · 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
site_name: vLLM Agentic API
site_description: Stateful API logic for agentic applications using vLLM
site_url: https://agentic-api.readthedocs.io/
repo_url: https://github.com/vllm-project/agentic-api
repo_name: vllm-project/agentic-api
edit_uri: edit/main/docs/

exclude_docs: |
  superpowers/
  mkdocs/generate_cli_reference.py

theme:
  name: material
  custom_dir: docs/mkdocs/overrides
  features:
    - content.action.edit
    - content.code.copy
    - content.tabs.link
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-2
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

extra_css:
  - mkdocs/stylesheets/extra.css

hooks:
  - docs/mkdocs/generate_cli_reference.py

plugins:
  - search
  - autorefs
  - git-revision-date-localized:
      type: datetime
      timezone: UTC
      fallback_to_build_date: true
      enable_creation_date: true
      # Generated from the CLI; this Markdown file has no independent git history.
      exclude:
        - reference/python-cli.md
        - reference/rust-cli.md
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true

markdown_extensions:
  - attr_list
  - def_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - API Reference: api/index.md
  - Command-Line Reference:
    - Rust CLI (agentic): reference/rust-cli.md
    - Python Launcher (agentic-api): reference/python-cli.md
  - Guides:
    - Python Installation: guides/python-installation.md
    - Responses Compaction: guides/responses-compaction.md
    - Harness CLI Testing: guides/harness-cli-testing.md
    - Codex Desktop: guides/codex-desktop.md
    - NVIDIA Dynamo Upstream: guides/dynamo-upstream.md
    - SGLang Upstream: guides/sglang-upstream.md
  - Developing:
    - Getting Started: developing/getting-started.md
    - Releases: developing/releases.md
  - Architecture:
    - ADR-01: adr/ADR-01_core.md
    - ADR-02: adr/ADR-02_response_store.md
    - ADR-03: adr/ADR-03_gateway_integration.md
    - Claude Code Integration: design/claude-code-integration.md
    - Codex Integration: design/codex-integration.md
    - llm-d Backend Mode: design/agentic-llm-d.md
    - Core Public API: design/core-public-api.md
    - MCP Gateway Integration: design/mcp-gateway-integration.md
    - Messages Gateway Tool Classification: design/messages-gateway-tool-classification.md
    - OIDC Bearer Authentication: design/oidc-bearer-authentication.md
    - Tool Framework: design/tool-framework.md
  - Deploying:
    - Container: deploying/container.md
    - GitHub authentication with Dex: deploying/github-oidc.md
    - Kubernetes: deploying/kubernetes.md
    - Kubernetes with kind: deploying/README.md
    - Observability: deploying/observability.md
  - Community: community/index.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vllm-project/agentic-api