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
[MNT] unpin sphinx
and plugins, with defensive upper bounds
#4823
Conversation
sphinx
and pluginssphinx
and plugins
Read the docs workflow seems to be working fine, so we can remove pins? (Assuming other workflows are all independent of |
Afaik this assumption is correct, I just checked the
Maybe upper bound to next major (or minor if zero-point), for safety? |
I doubt it'll have changes that'll break (You can commit with [skip ci] in commit message I think, it'll skip all Github workflows, but read-the-docs one will still run. ) |
Thanks for the reminder and learning moment! Although in this specific case, I think it's worth to check carefully whether it has any interactions with the other dependencies by a way we don't foresee. |
sphinx
and pluginssphinx
and plugins, with defensive upper bounds
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.
As long as read the docs workflow passes, I'm happy.
One minor non-blocking suggestion: use sphinx-issues
instead of sphinx_issues
as hyphen one is the PyPI name.
Similarly, Sphinx
instead of sphinx
. I don't think these differences matter though, as pip
checks only for sanitised versions.
Updated. I did not know that I knew it doesn't allow package names which are too close to existing ones, e.g., only dashes or capitalization away. |
This PR updates the readthedocs env to the current [official recommendations](https://docs.readthedocs.io/en/stable/config-file/v2.html), namely python 3.11 and ubuntu 22.04. That should also, hopefully, speed up the docs build. Depends on #4823 to include the fix for the `types` exception.
This PR replaces all the pins from
sphinx
and plugins with defensive upper bounds - next MAJOR release if the package is post-0, next MINOR release if the package is on zero-point.original post: Diagnostic PR to see what happens if we remove all the pins from sphinx and plugins.