pyutilz/mkdocs.yml at master · fingoldo/pyutilz · 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
site_name: pyutilz
site_description: A Python utilities library covering data-frame ops, databases, web/cloud, system monitoring, parallelism, and a unified async LLM-provider interface.
site_author: Anatoly Alexeev
site_url: https://fingoldo.github.io/pyutilz/
repo_url: https://github.com/fingoldo/pyutilz
repo_name: fingoldo/pyutilz
copyright: Copyright &copy; Anatoly Alexeev — MIT License

docs_dir: docs

# Fail the build on any MkDocs warning -- a nav entry pointing at a missing file, a broken
# internal link, or an unrecognised config key. Default is strict: false, i.e. warn-and-exit-0,
# which made docs.yml's per-PR "validation" run structurally incapable of catching a renamed or
# mistyped page (it would just ship a 404 on the published site). All five nav targets currently
# resolve, so this is a no-cost ratchet (2026-09-02 audit).
strict: true

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - search.suggest
    - content.code.copy
    - toc.follow

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details

nav:
  - Home: index.md
  - Modules: modules.md
  - Guides:
      - Unified LLM provider interface: guides/llm_providers.md
      - Kernel tuning cache: guides/kernel_tuning_cache.md
      - Safe pickle & sidecar verification: guides/safe_pickle.md