Skip to content

chore: switch docs build to PyPI sphinx-pyrunblock instead of git+https #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
taughz merged 2 commits into from
Oct 16, 2026
Merged

chore: switch docs build to PyPI sphinx-pyrunblock instead of git+https #221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6ce47f
chore: switch docs build to PyPI sphinx-pyrunblock instead of git+https
petercorke Sep 15, 2026
c13a94a
Merge branch 'master' into chore/sphinx-pyrunblock-pypi
taughz Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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.
  • Loading branch information
@petercorke
petercorke committed Sep 15, 2026
commit e6ce47fb22c8186c1bc087a00e351710fca824c7
1 change: 0 additions & 1 deletion .github/workflows/sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"sphinx.ext.inheritance_diagram",
"matplotlib.sphinxext.plot_directive",
"sphinx_autodoc_typehints",
"sphinx_autorun",
"sphinx_pyrunblock",
"sphinx.ext.intersphinx",
"sphinx_favicon",
]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ dev = [
docs = [
"sphinx",
"sphinx-rtd-theme",
"sphinx-autorun",
"sphinx-pyrunblock",
"sphinxcontrib-jsmath",
"sphinx-favicon",
"sphinx-autodoc-typehints",
Expand Down
Loading