Skip to content

Pin Redoc to v2 in generated API docs - #1288

Merged
Donkie merged 1 commit into
Donkie:masterfrom
devtechedge:fix/pin-redoc-v2
Oct 21, 2026
Merged

Donkie merged 1 commit into
Donkie:masterfrom
devtechedge:fix/pin-redoc-v2

Conversation

@devtechedge

Copy link
Copy Markdown
Contributor

Thanks for the clear console output in the report, it made this quick to trace.

generate_docs() in spoolman/docs.py loads Redoc from the unversioned cdn.jsdelivr.net/npm/redoc URL.

jsDelivr now resolves that to Redoc 3.0.1, whose standalone bundle contains import.meta.

That is a SyntaxError in a classic <script> tag, so the bundle never runs and Redoc.init fails with Redoc is not defined.

This pins the script to [email protected], the latest v2 release, whose standalone bundle has no import.meta.

I regenerated the docs with generate_docs() and checked that index.html now points at the pinned bundle, and ruff is clean.

Fixes #1287

@argos-ci

argos-ci Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Oct 20, 2026, 11:59 PM

@Donkie
Donkie merged commit 09f6a84 into Donkie:master Oct 21, 2026
18 checks passed
@devtechedge

Copy link
Copy Markdown
Contributor Author

Thank you for merging this, Donkie.

Pinning Redoc to v2 should keep the generated API docs rendering until the v3 bundle works in a classic script tag.

Happy to follow up if you would like the version bumped differently.

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.

API documentation page doesn't work.

2 participants