Skip to content
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

release the pin on Sphinx version ? #83

Closed
12rambau opened this issue Jan 9, 2023 · 6 comments · Fixed by #85
Closed

release the pin on Sphinx version ? #83

12rambau opened this issue Jan 9, 2023 · 6 comments · Fixed by #85
Labels
enhancement New feature or request

Comments

@12rambau
Copy link
Contributor

12rambau commented Jan 9, 2023

In the current implementation, jupyterlite-shinx enforces a Sphinx 4 version. Sphinx 6 is out since December and Sphinx 4 is starting to be dropped by other Sphinx extensions.

Would it be possible to change/remove this pinned version from setup.py ?

@12rambau 12rambau added the enhancement New feature or request label Jan 9, 2023
@martinRenou
Copy link
Member

martinRenou commented Jan 9, 2023

Yes we could try updating the pin to >=4,<7 and see if it still build properly with 6 :)

@lesteve
Copy link
Contributor

lesteve commented Feb 3, 2023

I bumped into this while working on sphinx-gallery Jupyterlite integration since sphinx-gallery is testing for a range of sphinx-version up the sphinx development version.

This is quite confusing right now that

pip install 'sphinx>6' jupyterlite-sphinx

will get you an old jupyterlite-sphinx version namely 0.4.0, which does not have the config.jupyterlite_bind_ipynb_suffix and so I spent quite some time figuring out why jupyterlite_bind_ipynb_suffix was not taken into account in some of the sphinx-gallery CI builds causing errors ...

@martinRenou
Copy link
Member

will get you an old jupyterlite-sphinx version namely 0.4.0

Yeah, this is because we did not have proper sphinx pinning at the time, we should have had the pin the entire time IMHO (not blaming anyone, I'm responsible for this I suppose). Let's release the pin then... Thanks for your PR!

@lesteve
Copy link
Contributor

lesteve commented Feb 3, 2023

Yeah, this is because we did not have proper sphinx pinning at the time

Yep, it does make sense given the constraints, but the behaviour for the user is still quite confusing. I guess this will be a lot better once there is a release with #85 in. In the meantime we can use a work-around.

In my case it took me a while to realise that it was the root cause, I thought that somehow the sphinx events were not happening in the right order.

we should have had the pin the entire time IMHO

Just curious, would you mind saying a few words why? In my mind jupyterlite-sphinx is a library not an application and I would think it does not really need to pin its dependencies. Also the jupyterlite-sphinx, code does not seem to rely on too many sphinx internals so I would think that it is not that likely to break between Sphinx major releases.

@martinRenou
Copy link
Member

this will be a lot better once there is a release with #85 in

jupyterlite-sphinx 0.7.3 is released :) You can use it

Just curious, would you mind saying a few words why? In my mind jupyterlite-sphinx is a library not an application and I would think it does not really need to pin its dependencies. Also the jupyterlite-sphinx, code does not seem to rely on too many sphinx internals so I would think that it is not that likely to break between Sphinx major releases.

Nothing prevents Sphinx devs to release a v7 that breaks the plugins API assumptions and break jupyterlite-sphinx. I want to prevent that, and to prevent the user to have to deal with debugging (like you had to do). But because we did not have proper pinning the entire time you ended up in this annoying position, sorry for that!

@lesteve
Copy link
Contributor

lesteve commented Feb 3, 2023

jupyterlite-sphinx 0.7.3 is released :) You can use it

Nice thanks a lot for this!

It is true that my experience from working on sphinx-gallery a long time ago (things may have changed a bit since) was that Sphinx tended to break things a little too often in my biased opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants