From a0fc998db6cb39eb18459feabe90aecca8975b23 Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Wed, 18 Nov 2026 08:49:02 +1000 Subject: [PATCH] docs: fail the docs build when a runblock example fails 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 --- docs/source/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index c35221e5..ada71d6e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -77,6 +77,8 @@ autorun_languages = {} autorun_languages["pycon_output_encoding"] = "UTF-8" autorun_languages["pycon_input_encoding"] = "UTF-8" +# a failing example fails the docs build, instead of publishing its traceback +autorun_languages["pycon_fail_on_error"] = True autorun_languages[ "pycon_runfirst" ] = """ @@ -123,9 +125,9 @@ "scipy": ("https://docs.scipy.org/doc/scipy/", None), "matplotlib": ("https://matplotlib.org/stable/", None), "open3d": ("https://www.open3d.org/docs/release/", None), - "smtb": ("https://github.com/rai-opensource/spatialmath-python", None), + "smtb": ("https://rai-opensource.github.io/spatialmath-python/", None), "pgraph": ("https://petercorke.github.io/pgraph-python/", None), - "torch": ("https://pytorch.org/docs/stable/", None), + "torch": ("https://docs.pytorch.org/docs/stable/", None), } # Ignore pseudo-types emitted in autodoc signatures/docstrings under nitpicky mode.