Skip to content

Make python api doc search match more things #11946

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

Merged
merged 2 commits into from
Nov 21, 2025
Merged

Make python api doc search match more things #11946

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12c423d
Make search match more things
ntjohnson1 Nov 21, 2025
488ffad
Add direct link to seprator magic
ntjohnson1 Nov 21, 2025
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
4 changes: 3 additions & 1 deletion rerun_py/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ theme:
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- search.share

plugins:
- search # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
- search: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
separator: '[\s\-,:!=\[\]()"/_]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
Copy link
Member

@emilk emilk Nov 21, 2025

Choose a reason for hiding this comment

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

Of course, how simple!

Copy link
Member

@emilk emilk Nov 21, 2025

Choose a reason for hiding this comment

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

Suggested change
separator: '[\s\-,:!=\[\]()"/_]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
separator: '[\s\-,:!=\[\]()"/_]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;' # Don't just match whole-words

maybe?

or just add a link to explain that monstrosity

Copy link
Member Author

@ntjohnson1 ntjohnson1 Nov 21, 2025

Choose a reason for hiding this comment

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

I copied that blob from the mkdocs-material page and inserted the _ to the separator list. Adding a comment to that effect.

- autorefs
- mkdocstrings: # https://mkdocstrings.github.io/usage/#global-options
custom_templates: docs/templates # Override the function template.
Expand Down
Loading