Skip to content

Conversation

@mgeier
Copy link
Member

@mgeier mgeier commented Mar 2, 2025

In general, I think pinning upper version bounds is not the right approach, but given the slew of incompatibilities introduced by Sphinx (in part involving 3rd party dependencies), I think it is best for my sanity and for most casual nbsphinx users to restrict Sphinx upgrades for now.

I hope it will become easier to support Sphinx upgrades at a later point.

This PR includes #823 in its entirety and parts of #826.

'nbformat',
'sphinx>=1.8',
# https://github.com/spatialaudio/nbsphinx/issues/825
'sphinx >= 1.8, < 8.2',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment in #825 (comment), I think that Sphinx 8.2.2 shoud now work with nbsphinx (though the explicit imports in #826 remain the correct solution)

Suggested change
'sphinx >= 1.8, < 8.2',
'sphinx >= 1.8, != 8.2.0, != 8.2.1',

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AA-Turner @mgeier I can confirm that sphinx 8.2.2 passes with current nbsphinx for now

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update!

I'm still getting a warning related to felix-hilden/sphinx-codeautolink#173.

I will un-pin Sphinx when this is done. I might also re-think the testing strategy for warnings, because keeping up with them is quite time-consuming.

I have just made a new nbsphinx release which still blocks Sphinx 8.2+.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mgeier I am not sure that should make you pin sphinx. sphinx-codeautolink is not a dependency of nbsphinx. The only reason you see that warning is that it is used in nbsphinxs own documentation (and thus triggered when you run that in ci) In my projects I use nbsphinx but not sphinx-codeautolink

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, to Matthias' point about testing strategy for warnings, enabling deprecation warnings for the documentation build (or non-core dependencies) probably isn't needed and may be unhelpful in this case.

@mgeier mgeier merged commit cc1981a into spatialaudio:master Mar 3, 2025
12 checks passed
@mgeier mgeier deleted the no-sphinx-8.2 branch March 3, 2025 19:51
@mgeier mgeier mentioned this pull request Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants