dspy-cli/mkdocs.yml at main · cmpnd-ai/dspy-cli · 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
site_name: dspy-cli
site_description: Scaffold and serve DSPy applications with ease
site_url: https://cmpnd-ai.github.io/dspy-cli/
repo_url: https://github.com/cmpnd-ai/dspy-cli
repo_name: cmpnd-ai/dspy-cli
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant        # Instant loading
    - navigation.sections       # Section navigation
    - navigation.indexes        # Section index pages
    - navigation.top            # Back to top button
    - navigation.tracking       # URL tracking
    - search.highlight          # Highlight search terms
    - search.suggest            # Search suggestions
    - content.code.copy         # Copy button on code blocks
    - content.action.edit       # Edit button on pages
    - toc.follow                # TOC follows scroll
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cmpnd-ai/dspy-cli

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2

markdown_extensions:
  # Code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  # Admonitions (notes, warnings, tips)
  - admonition
  - pymdownx.details

  # Tabbed content
  - pymdownx.tabbed:
      alternate_style: true

  # Better lists
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

  # Formatting
  - pymdownx.betterem
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.keys

  # Other
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Commands:
      - Overview: commands/index.md
      - new: commands/new.md
      - serve: commands/serve.md
      - generate: commands/generate.md
  - Gateways: gateways.md
  - Deployment: deployment.md
  - Configuration: configuration.md
  - Use Cases:
      - AI Features: use-cases/ai-features.md
  - Reference:
      - OpenAPI: OPENAPI.md
      - Releasing: releasing.md
  - Contributing: contributing.md