From e6ce47fb22c8186c1bc087a00e351710fca824c7 Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Tue, 15 Sep 2026 21:14:43 +0200 Subject: [PATCH] chore: switch docs build to PyPI sphinx-pyrunblock instead of git+https sphinx-pyrunblock is Peter's own package (published to PyPI, hard fork of the original WhyNotHugo/sphinx-autorun), reachable at the same content today via git+https://github.com/petercorke/sphinx-autorun.git (an old, pre-rename URL that still redirects). Installing the PyPI wheel directly is ~2-4x faster in CI (no git clone/VCS resolution) and makes pyproject.toml's declared dependency honest -- previously "sphinx-autorun" there would, in isolation, resolve to the unrelated upstream PyPI package of that name rather than Peter's fork. No functional change: both paths resolve to the same sphinx-pyrunblock 1.1.0 release. Verified with a real sphinx-build against a clean venv. --- .github/workflows/sphinx.yml | 1 - docs/source/conf.py | 2 +- pyproject.toml | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index c0beb95a..2c04a57f 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -17,7 +17,6 @@ jobs: run: | python -m pip install --upgrade pip pip install .[dev,docs] - pip install git+https://github.com/petercorke/sphinx-autorun.git pip install sympy sudo apt-get install graphviz - name: Build docs diff --git a/docs/source/conf.py b/docs/source/conf.py index b5fcf84a..66262759 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -47,7 +47,7 @@ "sphinx.ext.inheritance_diagram", "matplotlib.sphinxext.plot_directive", "sphinx_autodoc_typehints", - "sphinx_autorun", + "sphinx_pyrunblock", "sphinx.ext.intersphinx", "sphinx_favicon", ] diff --git a/pyproject.toml b/pyproject.toml index 95919eb3..e519f963 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,7 +61,7 @@ dev = [ docs = [ "sphinx", "sphinx-rtd-theme", - "sphinx-autorun", + "sphinx-pyrunblock", "sphinxcontrib-jsmath", "sphinx-favicon", "sphinx-autodoc-typehints",