Skip to content

DOC bump pydata-sphinx-theme to 0.15.3 #29134

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
Merged
merged 2 commits into from
May 31, 2024
Merged

DOC bump pydata-sphinx-theme to 0.15.3 #29134

merged 2 commits into from
May 31, 2024

Conversation

Charlie-XIAO
Copy link
Contributor

The 0.15.3 release of pydata-sphinx-theme provides a number of desired fixes and improvements. Except for bumping the minimum version, this PR:

Some changes to note about pydata-sphinx-theme==0.15.3:

@github-actions GitHub Actions
Copy link

github-actions bot commented May 30, 2024 •
edited
Loading

✔️ Linting Passed

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

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

@Charlie-XIAO Charlie-XIAO mentioned this pull request May 30, 2024
Merged
@lesteve
Copy link
Member

lesteve commented May 30, 2024 •
edited
Loading

Nice, thanks a lot for this!

The context in search seems to work fine: https://output.circle-artifacts.com/output/job/f40ba3a2-3300-4293-88c1-6c752b1c9e38/artifacts/0/doc/search.html?q=ridge

Just curious, is html_show_search_summary = True still needed in conf.py with pydata-sphinx-theme?

The diff looks reasonable although I have to admit I don't understand the scss part.

I pushed a commit with [doc] to make sure the full doc build works, since some libraries were updated like polars for example.

@Charlie-XIAO
Copy link
Contributor Author

Just curious, is html_show_search_summary = True still needed in conf.py with pydata-sphinx-theme?

html_show_search_summary = True is not needed because this is the default of sphinx (ref). However it has always been there since before I made the migration to the new theme, so I left it there.

lesteve
lesteve approved these changes May 30, 2024
View reviewed changes
Copy link
Member

@lesteve lesteve left a comment •
edited
Loading

Choose a reason for hiding this comment

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

The full doc build passed, the latest full doc build artifacts are here: https://output.circle-artifacts.com/output/job/3bdd81f3-2aff-49b0-bf91-46815178a07c/artifacts/0/doc/index.html

I quickly had a look and it looks fine.

@lesteve
Copy link
Member

lesteve commented May 30, 2024

Just curious, is html_show_search_summary = True still needed in conf.py with pydata-sphinx-theme?

html_show_search_summary = True is not needed because this is the default of sphinx (ref). However it has always been there since before I made the migration to the new theme, so I left it there.

OK thanks, I opened #29139 to remove it then.

@glemaitre
Copy link
Member

The install selector is much nicer :)

@glemaitre glemaitre merged commit 7398114 into scikit-learn:main May 31, 2024
30 checks passed
@Charlie-XIAO Charlie-XIAO deleted the bump-pst branch May 31, 2024 07:51
@lesteve lesteve mentioned this pull request May 31, 2024
Closed
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jul 2, 2024
@Charlie-XIAO @lesteve @jeremiedbb
DOC bump pydata-sphinx-theme to 0.15.3 (scikit-learn#29134)
edb8089 
Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
@jeremiedbb jeremiedbb mentioned this pull request Jul 2, 2024
Merged
11 tasks
jeremiedbb pushed a commit that referenced this pull request Jul 2, 2024
@Charlie-XIAO @lesteve @jeremiedbb
DOC bump pydata-sphinx-theme to 0.15.3 (#29134)
a2d0f5a 
Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lesteve lesteve lesteve approved these changes

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
Documentation improvement
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Charlie-XIAO @lesteve @glemaitre