Skip to content

Bump Jinja2 to 3.1.6 for docs - #10883

Open
luigi617 wants to merge 2 commits into
v2from
deps/docs-bump-jinja2
Open

luigi617 wants to merge 2 commits into
v2from
deps/docs-bump-jinja2

Conversation

@luigi617

@luigi617 luigi617 commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Bumps Jinja2 3.0.3 → 3.1.6 for the docs build, fixing Dependabot alerts #43, #44, #45, #46, #47 (GHSA-h5c8-rqwp-cp95, GHSA-h75v-3vvj-5mfj, GHSA-q2x7-8rv6-6q7h, GHSA-gmj6-6f8f-6699, GHSA-cpwx-vrp4-4pq7).

  • requirements-docs.txt: Jinja2<3.1.0 → Jinja2==3.1.6 (exact pin, matching Sphinx==6.2). The cap came from e4e4fbd ("Jinja2 3.1.0 breaks our doc build process") back when the docs used an older Sphinx. Sphinx 6.2 supports Jinja2 3.1, and the docs code (including the vendored guzzle_sphinx_theme) doesn't use any of the APIs removed in 3.1.
  • The lock file was regenerated with pip-compile on Python 3.9 using the command in its header, with --upgrade-package so only this package changes.

Testing (end-to-end)

Built the full HTML docs (make html, Python 3.9, Sphinx 6.2.0) on both v2 (Jinja2 3.0.3, Pygments 2.19.2) and this branch (Jinja2 3.1.6), then compared the two output trees with diff -rq:

  • Both builds produced 61,660 files, and every page matches byte for byte. The only file that differs is .buildinfo, where the config: hash changes because html_theme_path in conf.py is an absolute path and each build ran from a different checkout.
  • Both builds logged the same 1,482 warnings. These are existing RST warnings in the generated service reference pages.
  • Jinja2 ran across the whole site, because every page is rendered through the guzzle_sphinx_theme Jinja templates.

This PR was generated by AI tools, and reviewed by @luigi617.

@luigi617
luigi617 requested a review from a team as a code owner November 11, 2026 17:02

This branch has not been deployed

No deployments
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