-
Notifications
You must be signed in to change notification settings - Fork 316
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.
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
MAINT: Test old and new Sphinx versions #1413
Conversation
Looks like it's already showing a problem with the
I'll bump the minimum to 5.0 in this PR but someone should make sure that's the right thing to do! |
... I guess it's just a min required for the |
... also added concurrency to the GitHub actions build so that pushing repeated commits (like I did here) cancels previous ones in the same PR |
thank you @larsoner this was on my mental TODO list (I hadn't managed to even open an issue about it yet) |
.github/workflows/tests.yml
Outdated
# TODO: Can't build on dev because of dependency resolution :( | ||
# - os: ubuntu-latest | ||
# python-version: "3.11" | ||
# sphinx-version: "dev" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also can't test the doc build job on sphinx dev because of some dependency problem. Something to look at in the future since catching Sphinx warnings early (as it says are checked in this job) is pretty important I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
argh. yes, definitely want to test against sphinx dev; the events of this week make it obvious that we should have been doing that all along.
our policy is to support 2 versions back so dropping 4.x support is correct here. |
note to self: the sphinx dev dependency clash is coming from myst-nb which requires sphinx < 6 |
@choldgraf looks like the last release was in April, might be time for another that doesn't pin to an ancient Sphinx version :) |
Legit failure! https://github.com/pydata/pydata-sphinx-theme/actions/runs/5893186049/job/15984213602?pr=1413 Looks like it's due to jdillard/sphinx-sitemap#69 . That repo hasn't been updated in 6 months, can we drop |
All green other than macos taking ages to start. Old (now 5.0) and dev versions now tested in both pytest and doc-build jobs (when using the branch from jdillard/sphinx-sitemap#70 which seems okay until they cut a new version), ready for review/merge from my end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not exactly how I would have done it, but still a big step forward and we can always tweak it later. Thanks @larsoner!!
This should avoid ``` /home/runner/work/pydata-sphinx-theme/pydata-sphinx-theme/.tox/py312-docs/lib/python3.12/site-packages/sphinxcontrib/youtube/utils.py:9: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications. ``` showing up in our CI logs, by picking up a version that includes sphinx-contrib/youtube#56. This could/should have been done anytime after #1413
This is a proposal-by-PR:
No idea if this has been discussed so far but it seemed quick enough to just do it and see what people thought :)
FYI we use a dev test against NumPy/SciPy/matplotlib etc. in MNE-Python and find bugs in their dev branches fairly frequently. As a maintainer it's easy enough to know when a
dev
failure can be safely ignored for the time being...