Skip to content

DOC temporary fix for search summary #29090

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

Merged
merged 1 commit into from
May 24, 2024

Conversation

Charlie-XIAO
Copy link
Contributor

Fixes #29073.

This is a temporary workaround. It overwrites the default searchtools.js by copying a vendored searchtools.js with the same name into the static directory. The vendored searchtools.js replaces all occurrences of [role="main"] with #main-content, because pydata-sphinx-theme==0.15.2 has <main id="main-content" class="bd-main"> without the role="main".

After pydata-sphinx-theme==0.15.3 is release we can bump the minimum version of pydata-sphinx-theme to 0.15.3 and simply removed this vendored file.

Copy link

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: d2f8c42. Link to the linter CI: here

Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

I concur that this fixes the issue. I wouldn't have minded waiting for the release as @glemaitre mentioned. But since we have now this PR, we can also merge and push to the 1.5 branch as well.

Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM.

@glemaitre glemaitre merged commit 11e8c21 into scikit-learn:main May 24, 2024
34 checks passed
@glemaitre glemaitre added the To backport PR merged in master that need a backport to a release branch defined based on the milestone. label May 24, 2024
@glemaitre
Copy link
Member

We could therefore backport this fix to the stable branch.

@Charlie-XIAO Charlie-XIAO deleted the doc-search-summary branch May 24, 2024 10:54
@lesteve
Copy link
Member

lesteve commented May 29, 2024

sphinx-pydata-theme 0.15.3 has been released, I think we should revert this PR.

@Charlie-XIAO
Copy link
Contributor Author

I think it is not available on the conda-forge channel yet?

@lesteve
Copy link
Member

lesteve commented May 29, 2024

Indeed the conda-forge feedstock PR hasn't been merged yet and its CI is failing: conda-forge/pydata-sphinx-theme-feedstock#52

@Charlie-XIAO
Copy link
Contributor Author

#29134 reverts this PR, bumps the version, and makes fixes according to the new theme.

jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jul 2, 2024
@jeremiedbb jeremiedbb mentioned this pull request Jul 2, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation No Changelog Needed To backport PR merged in master that need a backport to a release branch defined based on the milestone.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx search summary disappeared from 1.5 website
4 participants