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.

Sign up for GitHub

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

Jump to bottom

v0.13.2 is incompatible with sphinx-book-theme #1274

Closed
jakevdp opened this issue Mar 29, 2023 · 6 comments
Closed

v0.13.2 is incompatible with sphinx-book-theme #1274

jakevdp opened this issue Mar 29, 2023 · 6 comments
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship

Comments

@jakevdp
Copy link

jakevdp commented Mar 29, 2023 •
edited
Loading

Reported in executablebooks/sphinx-book-theme#711

sphinx-book-theme imports pydata_sphinx_theme._get_theme_options, which was changed to _get_theme_options_dict in fc975d0

I think the fault here probably lies with sphinx-book-theme for importing what is presumably intended as a private API. What would be the suggested way forward? Would it be possible for get_theme_options_dict (or something equivalent) to be exposed as a stable/public API going forward?
@drammock
Copy link
Collaborator

yikes. I assumed when I renamed that func that there would be no downstream consequences because of the leading underscore. Looks like @12rambau is already planning to make it public in #1271 as part of new pydata_sphinx_theme.utils namespace

@12rambau
Copy link
Collaborator

yep it's ready to merge anytime and if you feel it's relevant, we can make a patch release so that you can link back to a stable version

@edublancas edublancas mentioned this issue Mar 29, 2023
Closed
@jakevdp
Copy link
Author

jakevdp commented Mar 29, 2023

Awesome, glad a more permanent fix is in the works!

@12rambau 12rambau added the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Mar 30, 2023
12rambau referenced this issue Mar 30, 2023
@drammock
don't warn on fallback if no highlight theme was requested (#1264)
fc975d0 
* don't warn on fallback if no highlight theme requested

* fix it for good

* move event back to build-finished

* better name, better doc

* cleanup

* simplify/safer
@jobrachem jobrachem mentioned this issue Mar 30, 2023
Merged
pnasrat added a commit to 2i2c-org/infrastructure that referenced this issue Mar 30, 2023
@pnasrat
Pin pydata-sphinx-theme to fix RTD build
4348e4e 
Fixes #2441

Ref pydata/pydata-sphinx-theme#1274
@pnasrat pnasrat mentioned this issue Mar 30, 2023
Merged
@michalk8 michalk8 mentioned this issue Mar 30, 2023
Merged
@12rambau
Copy link
Collaborator

0.13.3 have been released and the method get_theme_options_dict is now exposed in src.pydata_sphinx_theme.utils. is it solving your issue ?

@hCraker hCraker mentioned this issue Mar 30, 2023
Merged
4 tasks
@Maetveis Maetveis mentioned this issue Mar 30, 2023
Merged
@philipc2 philipc2 mentioned this issue Mar 30, 2023
Merged
@12rambau 12rambau pinned this issue Mar 31, 2023
pnasrat added a commit to 2i2c-org/sphinx-2i2c-theme that referenced this issue Apr 3, 2023
@pnasrat
Update sphinx-book-theme
c728a47 
This ensures use of a version that has fix for pydata/pydata-sphinx-theme#1274
@pnasrat pnasrat mentioned this issue Apr 3, 2023
Merged
@12rambau
Copy link
Collaborator

12rambau commented Apr 4, 2023

I'll leave it pinned on the issue dashboard but I'll close the issues as it seems to solve the problem. feel free to reopen if it's not the case.

@12rambau 12rambau closed this as completed Apr 4, 2023
@jakevdp
Copy link
Author

jakevdp commented Apr 4, 2023

Thanks!

To summarize the resolution for future users hitting this error, at the moment the following is true:

  • sphinx-book-theme<=1.0.0 is compatible with pydata-sphinx-theme<=0.13.1
  • sphinx-book-theme>=1.0.1 is compatible with pydata-sphinx-theme>=0.13.3

The best fix if you hit this bug would be to make sure both packages are updated to their most recent versions.

@dfsp-spirit dfsp-spirit mentioned this issue Apr 6, 2023
Closed
@12rambau 12rambau unpinned this issue May 30, 2023
@drammock drammock mentioned this issue Oct 25, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jakevdp @drammock @12rambau