odp-releaser/zensical.toml at main · gulfofmaine/odp-releaser · 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# Read more: https://zensical.org/docs/setup/basics

[project]
site_name = "odp-releaser"
site_description = "Tooling to help manage releasing Docker images across repos"
site_author = "Alex Kerney"
copyright = "&copy; 2026 Alex Kerney"
repo_url = "https://github.com/gulfofmaine/odp-releaser"
docs_dir = "docs"
nav = [
    "index.md",
    "getting-started.md",
    { "Source Repo" = [
        "source/index.md",
        "source/notify.md",
        "source/deploy_targets.md",
        "source/github_app.md",
    ]},
    { "Deployment Repo" = [
        "deploy/index.md",
        "deploy/bump_images.md",
        "deploy/syncing.md",
        "deploy/report_merged.md",
        "deploy/image_manifest.md",
        "deploy/github_app.md",
    ]},
    { "API" = [
        "api/github_apps.md",
        "api/actions.md",
        "api/cli.md",
        "api/client_payload.md",
    ]},
    { "Development" = [
        "development/index.md",
        "development/testing.md",
        "development/dump_event.md",
    ]},
]

# For Typer rendering
extra_css = ["https://cdn.jsdelivr.net/gh/termynal/termynal.py@0.14.0/termynal/assets/termynal.css"]
extra_javascript = ["https://cdn.jsdelivr.net/gh/termynal/termynal.py@0.14.0/termynal/assets/termynal.js"]

[project.theme]
language = "en"
features = [
    "announce.dismiss",
    "content.action.edit",
    "content.action.view",
    "content.code.annotate",
    "content.code.copy",
    "content.code.select",
    "content.footnote.tooltips",
    "content.tabs.link",
    "content.tooltips",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.path",
    "navigation.sections",
    "navigation.tabs",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
]
icon.repo = "fontawesome/brands/github"

# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"
[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/gulfofmaine/odp-releaser"

# Markdown extensions
#
[project.markdown_extensions.pymdownx.snippets]
check_paths = true

[project.markdown_extensions.admonition]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "python"
class = "python"
validator = "markdown_exec.validator"
format = "markdown_exec.formatter"
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "md"
class = "markdown"
validator = "markdown_exec.validator"
format = "markdown_exec.formatter"
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "bash"
class = "bash"
validator = "markdown_exec.validator"
format = "markdown_exec.formatter"
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "mermaid"
class = "mermaid"
format = "pymdownx.superfences.fence_code_format"

[project.markdown_extensions."mkdocs_typer2.markdown:makeExtension"]
pretty = false
engine = "native"

# ----------------------------------------------------------------------------
# Plugins configuration
# ----------------------------------------------------------------------------
#
# `default_handler` is deliberately left at its default of "python", since every
# `::: odp_releaser.*` block relies on it. Blocks that document an action or a
# reusable workflow name `handler: github` explicitly.
[project.plugins.mkdocstrings.handlers.github.options]
heading_level = 3
show_outputs = true # defaults to false
signature_repository = "gulfofmaine/odp-releaser"
# Render the example `uses:` as `@<sha-or-tag>` to match the pinning convention
# the prose teaches. The `ref`/`major`/`semver` modes read the checkout's git
# tags or branch name, neither of which is meaningful in a docs build.
signature_version = "string"
signature_version_string = "<sha-or-tag>"
signature_show_secrets = true

[project.plugins.mkdocstrings.handlers.python]
paths = ["src", "examples"]
inventories = ["https://docs.python.org/3/objects.inv"]

[project.plugins.mkdocstrings.handlers.python.options]
backlinks = "tree"
docstring_options = { "ignore_init_summary" = true }
docstring_section_style = "list"
filters = "public"
heading_level = 1
inherited_members = true
merge_init_into_class = true
parameter_headings = true
separate_signature = true
show_root_heading = true
show_root_full_path = false
show_signature_annotations = true
show_source = true
show_symbol_type_heading = true
show_symbol_type_toc = true
signature_crossrefs = true
summary = true
unwrap_annotated = true