chapkit/mkdocs.yml at main · winterop-com/chapkit · 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: Chapkit
site_description: Async SQLAlchemy database library for Python 3.13+ with FastAPI integration and ML workflow support
site_author: Morten Hansen
site_url: https://winterop-com.github.io/chapkit/
repo_name: winterop-com/chapkit
repo_url: https://github.com/winterop-com/chapkit
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      # Single-page app behavior
    - navigation.instant.prefetch
    - navigation.tracking     # URL updates with scroll
    - navigation.tabs         # Top-level sections as tabs
    - navigation.tabs.sticky  # Keep tabs visible when scrolling
    - navigation.sections     # Sections in sidebar
    - navigation.expand       # Expand sections by default
    - navigation.path         # Breadcrumb navigation
    - navigation.top          # Back to top button
    - navigation.indexes      # Index pages for sections
    - toc.follow              # TOC follows scroll
    - toc.integrate           # TOC integrated in nav (optional)
    - search.suggest          # Search suggestions
    - search.highlight        # Highlight search terms
    - search.share            # Share search results
    - content.code.copy       # Copy button for code blocks
    - content.code.annotate   # Code annotations
    - content.tabs.link       # Link content tabs

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/winterop-com/chapkit
      name: GitHub Repository

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: On this page

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
      base_path: docs
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            heading_level: 2

nav:
  - Home: index.md
  - Guides:
      - App Hosting: guides/app-hosting.md
      - Authentication: guides/authentication.md
      - Health Checks: guides/health-checks.md
      - Job Scheduler: guides/job-scheduler.md
      - ML Workflows: guides/ml-workflows.md
      - Monitoring: guides/monitoring.md
      - Task Execution: guides/task-execution.md
  - API Reference: api-reference.md

extra_css:
  - stylesheets/extra.css