batchling/mkdocs.yml at main · vienneraphael/batchling · 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
site_name: batchling
site_description: Save 50% off GenAI costs in two lines of code
site_url: https://batchling.pages.dev/
repo_name: vienneraphael/batchling
repo_url: https://github.com/vienneraphael/batchling
site_dir: docs-site
strict: true
exclude_docs: architecture/**

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/images/batchling-transparent.png
  favicon: assets/images/batchling-transparent.png
  pygments_style: tango
  pygments_style_dark: monokai
  font:
    text: IBM Plex Sans
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      accent: grey
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: grey
      accent: grey
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.tooltips
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow

extra:
  generator: false
  social_preview:
    title: "batchling"
    description: "Save 50% off GenAI costs in two lines of code"
    image: "https://batchling.pages.dev/assets/images/batchling-compressed.png"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vienneraphael/batchling
      name: GitHub
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/raphael-vienne/
      name: LinkedIn
    - icon: fontawesome/brands/discord
      link: https://discord.gg/8sdXXCXaHK
      name: Discord


plugins:
  - search
  - mkdocstrings:
      default_handler: python

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.snippets:
      base_path:
        - .
        - docs
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
      pygments_lang_class: true
  - toc:
      permalink: false

extra_css:
  - assets/stylesheets/extra.css
extra_javascript:
  - assets/javascripts/bash-command-highlight.js

nav:
  - batchling: index.md
  - Quickstart: quickstart.md
  - batchify: batchify.md
  - Core Components:
      - Python SDK: python-sdk.md
      - CLI: cli.md
  - Providers:
      - Overview: providers.md
      # BEGIN AUTO-GENERATED PROVIDER NAV
      - Anthropic: providers/anthropic.md
      - Doubleword: providers/doubleword.md
      - Gemini: providers/gemini.md
      - Groq: providers/groq.md
      - Mistral: providers/mistral.md
      - OpenAI: providers/openai.md
      - Sference: providers/sference.md
      - Together: providers/together.md
      - Vertex: providers/vertex.md
      - XAI: providers/xai.md
      # END AUTO-GENERATED PROVIDER NAV
  - Frameworks:
      - Overview: frameworks.md
      # BEGIN AUTO-GENERATED FRAMEWORK NAV
      - DSPy: frameworks/dspy.md
      - Instructor: frameworks/instructor.md
      - LangChain: frameworks/langchain.md
      - LiteLLM: frameworks/litellm.md
      - Pydantic AI: frameworks/pydantic_ai.md
      - Pydantic Evals: frameworks/pydantic_evals.md
      # END AUTO-GENERATED FRAMEWORK NAV
  - Use-Cases:
      - Overview: use-cases.md
      - Streaming batches: use-cases/streaming-batches.md
  - Advanced Features:
      - Overview: advanced-features.md
      - Cache: cache.md
      - Dry Run: dry-run.md
  - How It Works: how-it-works.md