Skip to content

Update docs dependencies and cap zensical below 0.0.71 - #112

Merged
jonathan343 merged 1 commit into
developfrom
cap-zensical-0.0.71
Oct 19, 2026
Merged

jonathan343 merged 1 commit into
developfrom
cap-zensical-0.0.71

Conversation

@jonathan343

Copy link
Copy Markdown
Contributor

Summary

Zensical v0.0.71 added a size limit for each search index field, and the limit shrinks as the site grows (zensical@391e658). Our site has about 58k sections, which caps each field at 16 KiB. GuardDuty's CreateFilterInput.finding_criteria docstring renders to 48 KiB, so zensical build fails before it writes search.json. requirements-docs.in allowed any 0.0.* release, so builds picked up 0.0.71 as soon as it shipped.

This PR caps zensical below 0.0.71 in requirements-docs.in and locks it to 0.0.70. It also moves the other docs dependencies to their latest versions: markdown 3.11.1, mkdocstrings 1.0.7, pymdown-extensions 12.3 and platformdirs 4.13.5. A follow-up will keep oversized docstrings out of search and remove the cap.

Before / After

Full docs build for all 25 clients on Python 3.12:

uv pip install -r requirements-docs.in
uv pip install clients/*
python scripts/docs/generate_all_doc_stubs.py
python scripts/docs/generate_nav.py
zensical build

Before

RuntimeError: Search field 'text' at 'clients/guardduty/operations/create_filter/#aws_sdk_guardduty.models.CreateFilterInput.finding_criteria' exceeds the search index limit (48564 bytes; maximum 16384 bytes for 57880 items). Shorten this field, split the page into smaller sections, or exclude it from search.

After (this branch, resolves zensical 0.0.70)

Build started
No issues found
Build finished in 63.03s

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

zensical 0.0.71 rejects search fields over a size limit derived from the
index's section count. The combined docs site has about 58k sections, which
caps fields at 16 KiB, and GuardDuty's CreateFilterInput.finding_criteria
docstring renders to about 48 KiB, so the build fails.

Cap zensical below 0.0.71 until the docs keep oversized docstrings out of
search, and refresh the other docs dependencies to their latest versions.
@jonathan343
jonathan343 merged commit 8e001c7 into develop Oct 19, 2026
4 checks passed
@jonathan343
jonathan343 deleted the cap-zensical-0.0.71 branch October 19, 2026 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants