Skip to content

DOC: Enable Sphinx-Gallery example recommender #13867

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

Open
kidusabe1 wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −0
Open

DOC: Enable Sphinx-Gallery example recommender #13867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13867.other.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Enable the Sphinx-Gallery example recommender so each gallery page links to the most similar examples, by :newcontrib:`Kidus Abebe`.
1 change: 1 addition & 0 deletions doc/changes/names.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@
.. _Katia Al-Amir: https://github.com/katia-sentry
.. _Kay Robbins: https://github.com/VisLab
.. _Keith Doelling: https://github.com/kdoelling1919
.. _Kidus Abebe: https://github.com/kidusabe1
.. _Konstantinos Tsilimparis: https://contsili.github.io/
.. _Kostiantyn Maksymenko: https://github.com/makkostya
.. _Kristijan Armeni: https://github.com/kristijanarmeni
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,7 @@
),
"copyfile_regex": r".*index\.rst", # allow custom index.rst files
"parallel": sphinx_gallery_parallel,
"recommender": {"enable": True},
Copy link

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

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

Enabling the Sphinx-Gallery recommender generally adds a hard runtime dependency on scikit-learn during doc builds and can noticeably increase gallery build time/memory (it needs to vectorize example sources). If this repo has any doc-build paths that don’t install the full doc extras, this can cause build failures. Consider enabling this conditionally (e.g., only when scikit-learn is importable, or behind an env var used by CI) and/or setting the recommender parameters explicitly to keep behavior stable across sphinx-gallery version changes (e.g., n_examples, min_df, max_df).

Copilot uses AI. Check for mistakes.
}
assert is_serializable(sphinx_gallery_conf)
# Files were renamed from plot_* with:
Expand Down
Loading