Skip to content

Commit 5ba7f8b

Browse files
committed
Deployed 8bdff16 with MkDocs version: 1.6.1
1 parent bbfb0ba commit 5ba7f8b

File tree

11 files changed

+168
-174
lines changed

11 files changed

+168
-174
lines changed

changelog/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

coverage/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
coviframe.contentWindow.document.body.onclick = function() {
1313
coviframe.contentWindow.location.reload();
1414
}
15-
</script> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 24, 2026 15:57:30 UTC"><span class=timeago datetime=2026-01-24T15:57:30+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 24, 2026 15:57:30 UTC">2026-01-24</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 24, 2026 15:57:30 UTC"><span class=timeago datetime=2026-01-24T15:57:30+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 24, 2026 15:57:30 UTC">2026-01-24</span> </span> </aside> <form class=md-feedback name=feedback hidden> <fieldset> <legend class=md-feedback__title> Was this page helpful? </legend> <div class=md-feedback__inner> <div class=md-feedback__list> <button class="md-feedback__icon md-icon" type=submit title="This page was helpful" data-md-value=1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> </button> <button class="md-feedback__icon md-icon" type=submit title="This page could be improved" data-md-value=0> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg> </button> </div> <div class=md-feedback__note> <div data-md-value=1 hidden> Thanks for your feedback! </div> <div data-md-value=0 hidden> Let us know how we can improve this page. </div> </div> </div> </fieldset> </form> <!-- Giscus --> <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration --> <div id=feedback style="display: none;"> <h2 id=__comments>Feedback</h2> <script src=https://giscus.app/client.js data-repo=mkdocstrings/mkdocstrings data-repo-id="MDEwOlJlcG9zaXRvcnkyMjY5MzY0MTY=" data-category=Documentation data-category-id=DIC_kwDODYbGYM4ChKXy data-mapping=pathname data-strict=1 data-reactions-enabled=0 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
15+
</script> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="February 7, 2026 14:31:46 UTC"><span class=timeago datetime=2026-02-07T14:31:46+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="February 7, 2026 14:31:46 UTC">2026-02-07</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="February 7, 2026 14:31:46 UTC"><span class=timeago datetime=2026-02-07T14:31:46+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="February 7, 2026 14:31:46 UTC">2026-02-07</span> </span> </aside> <form class=md-feedback name=feedback hidden> <fieldset> <legend class=md-feedback__title> Was this page helpful? </legend> <div class=md-feedback__inner> <div class=md-feedback__list> <button class="md-feedback__icon md-icon" type=submit title="This page was helpful" data-md-value=1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> </button> <button class="md-feedback__icon md-icon" type=submit title="This page could be improved" data-md-value=0> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg> </button> </div> <div class=md-feedback__note> <div data-md-value=1 hidden> Thanks for your feedback! </div> <div data-md-value=0 hidden> Let us know how we can improve this page. </div> </div> </div> </fieldset> </form> <!-- Giscus --> <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration --> <div id=feedback style="display: none;"> <h2 id=__comments>Feedback</h2> <script src=https://giscus.app/client.js data-repo=mkdocstrings/mkdocstrings data-repo-id="MDEwOlJlcG9zaXRvcnkyMjY5MzY0MTY=" data-category=Documentation data-category-id=DIC_kwDODYbGYM4ChKXy data-mapping=pathname data-strict=1 data-reactions-enabled=0 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
1616
</script> <!-- Synchronize Giscus theme with palette --> <script>
1717
var giscus = document.querySelector("script[src*=giscus]")
1818

credits/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

css/timeago.css

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
/*
1+
/*
22
timeago output is dynamic, which breaks when you print a page.
33
4-
This CSS is only included when type: timeago
4+
This CSS is only included when type: timeago
55
and ensures fallback to type "iso_date" when printing.
6-
6+
77
*/
88

99
.git-revision-date-localized-plugin-iso_date { display: none }
1010

1111
@media print {
12-
.git-revision-date-localized-plugin-iso_date { display: inline }
13-
.git-revision-date-localized-plugin-timeago { display: none }
12+
.git-revision-date-localized-plugin-iso_date { display: inline }
13+
.git-revision-date-localized-plugin-timeago { display: none }
1414
}
15-

js/timeago.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

llms-full.txt

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1834,16 +1834,14 @@ def __init__(
18341834

18351835
# add extended theme templates
18361836
extended_templates_dirs = self.get_extended_templates_dirs(self.name)
1837-
for templates_dir in extended_templates_dirs:
1838-
paths.append(templates_dir / self.theme)
1837+
paths.extend(templates_dir / self.theme for templates_dir in extended_templates_dirs)
18391838

18401839
# add fallback theme templates
18411840
if self.fallback_theme and self.fallback_theme != self.theme:
18421841
paths.append(themes_dir / self.fallback_theme)
18431842

18441843
# add fallback theme of extended templates
1845-
for templates_dir in extended_templates_dirs:
1846-
paths.append(templates_dir / self.fallback_theme)
1844+
paths.extend(templates_dir / self.fallback_theme for templates_dir in extended_templates_dirs)
18471845

18481846
for path in paths:
18491847
css_path = path / "style.css"
@@ -2081,24 +2079,24 @@ def do_convert_markdown(
20812079
global _markdown_conversion_layer # noqa: PLW0603
20822080
_markdown_conversion_layer += 1
20832081
treeprocessors = self.md.treeprocessors
2084-
treeprocessors[HeadingShiftingTreeprocessor.name].shift_by = heading_level # type: ignore[attr-defined]
2085-
treeprocessors[IdPrependingTreeprocessor.name].id_prefix = html_id and html_id + "--" # type: ignore[attr-defined]
2086-
treeprocessors[ParagraphStrippingTreeprocessor.name].strip = strip_paragraph # type: ignore[attr-defined]
2082+
treeprocessors[HeadingShiftingTreeprocessor.name].shift_by = heading_level
2083+
treeprocessors[IdPrependingTreeprocessor.name].id_prefix = html_id and html_id + "--"
2084+
treeprocessors[ParagraphStrippingTreeprocessor.name].strip = strip_paragraph
20872085
if BacklinksTreeProcessor.name in treeprocessors:
2088-
treeprocessors[BacklinksTreeProcessor.name].initial_id = html_id # type: ignore[attr-defined]
2086+
treeprocessors[BacklinksTreeProcessor.name].initial_id = html_id
20892087
if autoref_hook and AutorefsInlineProcessor.name in self.md.inlinePatterns:
2090-
self.md.inlinePatterns[AutorefsInlineProcessor.name].hook = autoref_hook # type: ignore[attr-defined]
2088+
self.md.inlinePatterns[AutorefsInlineProcessor.name].hook = autoref_hook # ty: ignore[unresolved-attribute]
20912089

20922090
try:
20932091
return Markup(self.md.convert(text))
20942092
finally:
2095-
treeprocessors[HeadingShiftingTreeprocessor.name].shift_by = 0 # type: ignore[attr-defined]
2096-
treeprocessors[IdPrependingTreeprocessor.name].id_prefix = "" # type: ignore[attr-defined]
2097-
treeprocessors[ParagraphStrippingTreeprocessor.name].strip = False # type: ignore[attr-defined]
2093+
treeprocessors[HeadingShiftingTreeprocessor.name].shift_by = 0
2094+
treeprocessors[IdPrependingTreeprocessor.name].id_prefix = ""
2095+
treeprocessors[ParagraphStrippingTreeprocessor.name].strip = False
20982096
if BacklinksTreeProcessor.name in treeprocessors:
2099-
treeprocessors[BacklinksTreeProcessor.name].initial_id = None # type: ignore[attr-defined]
2097+
treeprocessors[BacklinksTreeProcessor.name].initial_id = None
21002098
if AutorefsInlineProcessor.name in self.md.inlinePatterns:
2101-
self.md.inlinePatterns[AutorefsInlineProcessor.name].hook = None # type: ignore[attr-defined]
2099+
self.md.inlinePatterns[AutorefsInlineProcessor.name].hook = None
21022100
self.md.reset()
21032101
_markdown_conversion_layer -= 1
21042102
```
@@ -3113,7 +3111,7 @@ Returns:
31133111
Source code in `src/mkdocstrings/_internal/handlers/rendering.py`
31143112

31153113
```python
3116-
def highlight(
3114+
def highlight( # ty: ignore[invalid-method-override]
31173115
self,
31183116
src: str,
31193117
language: str | None = None,
@@ -3142,7 +3140,7 @@ def highlight(
31423140
src = textwrap.dedent(src)
31433141

31443142
kwargs.setdefault("css_class", self._css_class)
3145-
old_linenums = self.linenums # type: ignore[has-type]
3143+
old_linenums = self.linenums
31463144
if linenums is not None:
31473145
self.linenums = linenums
31483146
try:
@@ -3813,7 +3811,7 @@ def log(self, level: int, msg: object, *args: object, **kwargs: object) -> None:
38133811
if (key := (self, str(msg))) in self._logged:
38143812
return
38153813
self._logged.add(key)
3816-
super().log(level, msg, *args, **kwargs) # type: ignore[arg-type]
3814+
super().log(level, msg, *args, **kwargs) # ty: ignore[invalid-argument-type]
38173815
```
38183816

38193817
### process
@@ -3952,7 +3950,7 @@ def extendMarkdown(self, md: Markdown) -> None: # noqa: N802 (casing: parent me
39523950

39533951
# Zensical integration: get the current page from the Zensical-specific preprocessor.
39543952
if "zensical_current_page" in md.preprocessors:
3955-
self._autorefs.current_page = md.preprocessors["zensical_current_page"] # type: ignore[assignment]
3953+
self._autorefs.current_page = md.preprocessors["zensical_current_page"]
39563954

39573955
md.parser.blockprocessors.register(
39583956
AutoDocProcessor(md, handlers=self._handlers, autorefs=self._autorefs),
@@ -4259,7 +4257,7 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
42594257
handlers = Handlers(
42604258
default=self.config.default_handler,
42614259
handlers_config=self.config.handlers,
4262-
theme=config.theme.name or os.path.dirname(config.theme.dirs[0]),
4260+
theme=config.theme.name or os.path.dirname(config.theme.dirs[0]), # noqa: PTH120
42634261
custom_templates=self.config.custom_templates,
42644262
mdx=config.markdown_extensions,
42654263
mdx_config=config.mdx_configs,
@@ -4275,7 +4273,7 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
42754273
autorefs: AutorefsPlugin
42764274
try:
42774275
# If autorefs plugin is explicitly enabled, just use it.
4278-
autorefs = config.plugins["autorefs"] # type: ignore[assignment]
4276+
autorefs = config.plugins["autorefs"] # ty: ignore[invalid-assignment]
42794277
_logger.debug("Picked up existing autorefs instance %r", autorefs)
42804278
except KeyError:
42814279
# Otherwise, add a limited instance of it that acts only on what's added through `register_anchor`.
@@ -4286,7 +4284,7 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
42864284
_logger.debug("Added a subdued autorefs instance %r", autorefs)
42874285

42884286
mkdocstrings_extension = MkdocstringsExtension(handlers, autorefs)
4289-
config.markdown_extensions.append(mkdocstrings_extension) # type: ignore[arg-type]
4287+
config.markdown_extensions.append(mkdocstrings_extension) # ty: ignore[invalid-argument-type]
42904288

42914289
config.extra_css.insert(0, self.css_filename) # So that it has lower priority than user files.
42924290

@@ -4796,7 +4794,8 @@ makeExtension(
47964794
inventory_version: str | None = None,
47974795
handlers: dict[str, dict] | None = None,
47984796
custom_templates: str | None = None,
4799-
markdown_extensions: list[str | dict] | None = None,
4797+
markdown_extensions: list[str | dict | Extension]
4798+
| None = None,
48004799
locale: str | None = None,
48014800
config_file_path: str | None = None,
48024801
) -> MkdocstringsExtension
@@ -4816,7 +4815,7 @@ def makeExtension( # noqa: N802
48164815
inventory_version: str | None = None,
48174816
handlers: dict[str, dict] | None = None,
48184817
custom_templates: str | None = None,
4819-
markdown_extensions: list[str | dict] | None = None,
4818+
markdown_extensions: list[str | dict | Extension] | None = None,
48204819
locale: str | None = None,
48214820
config_file_path: str | None = None,
48224821
) -> MkdocstringsExtension:

0 commit comments

Comments
 (0)