lm15-python/mkdocs.yml at main · lm15-dev/lm15-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
site_name: lm15
site_description: "Provider-neutral, low-level foundation for LLM APIs — one canonical representation, exact serde, zero dependencies."
site_url: https://lm15-dev.github.io/lm15-python/
repo_url: https://github.com/lm15-dev/lm15-python
repo_name: lm15-dev/lm15-python

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            members_order: source
            docstring_style: google
            show_signature_annotations: true

not_in_nav: |
  cookbooks/STYLE.md
  drafts/*.md

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Guides:
      - Providers & models: providers-and-models.md
      - Authentication: authentication.md
      - Managed login: managed-login.md
      - Rate-limit and capacity diagnostics: error-diagnostics.md
      - Cloud hosts (AWS, Azure, Google Cloud): cloud-hosts.md
      - The router: using-the-router.md
      - Adaptations (switch providers, keep your program): adaptations.md
      - The type system: using-the-type-system.md
      - Migrating from an OpenAI-shaped client: migrating-from-openai-chat.md
      - Providers: using-the-a-provider.md
      - Model profiles & compat: using-model-profiles.md
      - Connect an unlisted OpenAI-compatible server: connecting-openai-compatible-servers.md
      - Transports: using-the-transports.md
      - Design rationale: design-rationale.md
      - Security assessment: security-assessment.md
  - Cookbooks:
      - Overview: cookbooks/index.md
      - Essentials:
          - Your first request: cookbooks/01-first-request.md
          - Multi-turn conversations: cookbooks/02-conversations.md
          - System & developer prompts: cookbooks/03-system-prompts.md
          - Controlling generation: cookbooks/04-generation-config.md
          - Streaming: cookbooks/05-streaming.md
      - Tools:
          - Function tools: cookbooks/06-function-tools.md
          - Built-in provider tools: cookbooks/07-builtin-tools.md
          - Structured output: cookbooks/08-structured-output.md
      - Modalities:
          - Images, PDFs & documents: cookbooks/09-images-and-documents.md
          - Audio, video & reasoning models: cookbooks/10-audio-video-reasoning.md
      - Beyond chat:
          - Prompt caching: cookbooks/11-caching.md
          - Batch jobs: cookbooks/12-batch-jobs.md
          - Media generation (images & speech): cookbooks/13-media-generation.md
          - Video generation: cookbooks/14-video-generation.md
          - Live sessions (realtime): cookbooks/15-live-sessions.md
      - Production:
          - Local & OpenAI-compatible servers: cookbooks/16-local-and-compatible-servers.md
          - Errors, retries & testing: cookbooks/17-errors-and-testing.md
          - Provider passthrough: cookbooks/18-provider-passthrough.md
          - Prompt caching: cookbooks/19-prompt-caching.md
  - Specification:
      - How lm15 is specified: how-lm15-is-specified.md
      - Serde rules: serde-rules.md
      - Mapping rules: mapping-rules.md
      - Model hydration: model-hydration.md
      - Router portability (proposal): router-portability.md
  - API reference:
      - Types: reference/types.md
      - Providers: reference/providers.md
      - Streaming results: reference/result.md
      - Errors: reference/errors.md
      - Serde: reference/serde.md
      - Profiles & models: reference/profiles.md
      - Transports: reference/transports.md
  - Benchmarks: benchmarks.md
  - Roadmap: roadmap.md