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

NBConvert 6.0 Changes #6773

Closed
MSeal opened this issue Oct 25, 2019 · 5 comments
Closed

NBConvert 6.0 Changes #6773

MSeal opened this issue Oct 25, 2019 · 5 comments
Labels
type:enhancement enhance or introduce a new feature

Comments

@MSeal
Copy link

MSeal commented Oct 25, 2019

Is your feature request related to a problem? Please describe.
With nbconvert development of master branch now working towards 6.0 there's likely some upcoming compatibility issues with the changes.

Describe the solution you'd like
It seems that the master branch of nbconvert with some early 6.0 changes will break sphinx template tasks. I added specific details at the bottom about what these changes are.

I'm not sure how you'll want to prep sphinx for the changes, but I imagine an nbconvert 6.0 branch or code path will be needed to account for the changes. Likely this would need a branch first to prove it out and discover any open issues at a minimum.

Describe alternatives you've considered
If there's tweaks needed in nbconvert ahead the big release to make sphinx's upgrade easier we're open to helping making such changes.

Additional context
jupyter/nbconvert#1126 raised that their accidental pin to master had failures in this manner. Specifically jupyter/nbconvert#1028 reorganized templates with a large change to make viola and nbconvert more compatible with each other (and make templates better overall). Some of the other coming changes may also cause minor issues as they're being made. We're allowing more dramatic changes to the library given it's a major version change.

@MSeal MSeal added the type:enhancement enhance or introduce a new feature label Oct 25, 2019
@tk0miya
Copy link
Member

tk0miya commented Oct 26, 2019

I still don't understand what we should do. Is there anything to do from Sphinx side? Are you saying jupyter/nbconvert#1126 is a bug of Sphinx core?

@mgeier
Copy link
Contributor

mgeier commented Oct 26, 2019

I don't think anything can be done from the Sphinx side, see jupyter/nbconvert#1126 (comment).

@tk0miya
Copy link
Member

tk0miya commented Oct 26, 2019

Okay, I understand. Thank you for your help :-)

@tk0miya tk0miya closed this as completed Oct 26, 2019
@MSeal
Copy link
Author

MSeal commented Oct 26, 2019

Thanks for taking a look. I wasn't sure if Sphinx had hardcoded template names or direct imports that might be impacted. I mostly wanted to give a heads up about the upcoming changes so you all would be aware as there's a lot of Sphinx usage with nbconvert involved in various projects

@tk0miya
Copy link
Member

tk0miya commented Oct 27, 2019

I think it is better to post such announcement to sphinx-users group. Then users will catch up the news and changes.
Anyway, thank you for information. I'm looking forward to see new package :-)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

3 participants