Skip to content

docs: fail the docs build when a runblock example fails - #175

Merged
petercorke merged 2 commits into
mainfrom
docs/runblock-clean
Nov 18, 2026
Merged

petercorke merged 2 commits into
mainfrom
docs/runblock-clean

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Turns on sphinx-pyrunblock's pycon_fail_on_error, so a failing example fails the docs build instead of publishing its traceback. Also fixes two dead intersphinx URLs (spatialmath 404, PyTorch moved).

The seven failing examples listed in #159 were already fixed by #161, and the current docs build has zero RUNBLOCK-ERRORs. Warning clean-up is a separate PR.

Closes #159

🤖 Generated with Claude Code

Turn on sphinx-pyrunblock's pycon_fail_on_error so a broken example no
longer publishes its traceback. Also point intersphinx at the live
spatialmath (rai-opensource.github.io) and PyTorch (docs.pytorch.org)
inventories; the old URLs returned 404 and a redirect.

Refs #159

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@petercorke
petercorke merged commit 3f6897f into main Nov 18, 2026
33 checks passed
@petercorke
petercorke deleted the docs/runblock-clean branch November 18, 2026 22:34
@github-actions github-actions Bot mentioned this pull request Nov 18, 2026
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.

Docs build succeeds with broken examples: fix 7 failing runblock examples and fail the build on errors

1 participant