interlock/zensical.toml at main · bagowix/interlock · 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
[project]
site_name = "interlock"
site_description = "A modern circuit breaker for Python: sync + async, sliding-window rate, slow-call detection, type-safe API."
site_author = "bagowix"
site_url = "https://bagowix.github.io/interlock/"
repo_url = "https://github.com/bagowix/interlock"
copyright = "Copyright &copy; 2026 interlock authors"

nav = [
    { "Home" = "index.md" },
    { "Getting started" = "getting-started.md" },
    { "Runnable demo" = "demo.md" },
    { "Comparison" = "comparison.md" },
    { "Migration" = "migration.md" },
    { "Correctness and testing" = "correctness.md" },
    { "Guides" = ["guides/configuration.md", "guides/states.md", "guides/failure-classification.md", "guides/observability.md", "guides/timeout.md", "guides/retries.md", "guides/pipeline.md"] },
    { "Integrations" = ["integrations/index.md", "integrations/fastapi.md", "integrations/litestar.md", "integrations/httpx2.md", "integrations/httpx.md", "integrations/aiohttp.md", "integrations/requests.md", "integrations/llm.md", "integrations/tenacity.md", "integrations/redis.md", "integrations/frameworks.md"] },
    { "Reference" = ["reference.md"] },
]

[project.theme]
language = "en"
custom_dir = "overrides"
features = [
    "content.action.view",
    "content.code.annotate",
    "content.code.copy",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.sections",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
    "toc.follow",
]

[[project.theme.palette]]
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
    { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

# Titles for readers who have not arrived yet: search results, pasted links,
# social cards. Keyed by page url ("" is the landing page), consumed by the
# htmltitle and extrahead blocks in overrides/main.html, which append the site
# name. Keep each under ~60 characters or search engines truncate it. A page
# left out of this map keeps the theme's "<page title> - interlock".
[project.extra.seo_titles]
"" = "A modern circuit breaker for Python"
"getting-started/" = "Getting started with a Python circuit breaker"
"comparison/" = "Python circuit breaker libraries compared"
"migration/" = "Migrating from pybreaker or circuitbreaker"
"demo/" = "A runnable Python circuit breaker demo"
"correctness/" = "How the circuit breaker is tested for correctness"
"reference/" = "Python circuit breaker API reference"
"guides/configuration/" = "Configuring a Python circuit breaker"
"guides/states/" = "Circuit breaker states and manual control"
"guides/failure-classification/" = "Which failures should trip a circuit breaker"
"guides/observability/" = "Circuit breaker metrics and OpenTelemetry"
"guides/timeout/" = "Timeouts with a Python circuit breaker"
"guides/retries/" = "Retries and circuit breakers in Python"
"guides/pipeline/" = "Resilience pipeline: timeout, retry, bulkhead"
"integrations/" = "Circuit breaker integrations for Python clients"
"integrations/fastapi/" = "FastAPI circuit breaker with 503 and Retry-After"
"integrations/litestar/" = "Litestar circuit breaker with 503 and Retry-After"
"integrations/httpx/" = "httpx circuit breaker transport"
"integrations/httpx2/" = "httpx2 circuit breaker transport"
"integrations/aiohttp/" = "aiohttp circuit breaker middleware"
"integrations/requests/" = "requests circuit breaker adapter"
"integrations/redis/" = "Distributed circuit breaker state in Redis"
"integrations/tenacity/" = "tenacity retries with a circuit breaker"
"integrations/llm/" = "Circuit breaker for OpenAI and Anthropic calls"
"integrations/frameworks/" = "Circuit breaker for Flask and Django"