Make python api doc search match more things #11946
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntjohnson1
added
📖 documentation
|
Your changes can be cherry-picked to |
emilk
approved these changes
Nov 21, 2025
| 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;' |
| 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;' |
Member
There was a problem hiding this comment.
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
Member
Author
There was a problem hiding this comment.
I copied that blob from the mkdocs-material page and inserted the _ to the separator list. Adding a comment to that effect.
rerun-bot
pushed a commit
that referenced
this pull request
Nov 21, 2025
### Related #11902 ### What Our python search by default looked for perfect matches which is 😠. This does a lazy improvement to at least split things along various characters to make it easier to match approximately. There are other features we could continue to tweak if necessary (or could overhaul with a better external search support index). I still don't really know how to get our python api docs to update besides releasing a new version so run `pixi run py-docs-serve` locally and see that we now math the motivating issue (or trust me). I also added a share link so I can refer to searches in the future without screenshots. <img width="762" height="746" alt="Screenshot 2025-11-21 at 2 32 24 PM" src="https://github.com/user-attachments/assets/4b02bbc7-5735-4ed6-948d-5c1e2664c2bd" />
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related
#11902
What
Our python search by default looked for perfect matches which is 😠. This does a lazy improvement to at least split things along various characters to make it easier to match approximately. There are other features we could continue to tweak if necessary (or could overhaul with a better external search support index).
I still don't really know how to get our python api docs to update besides releasing a new version so run
pixi run py-docs-servelocally and see that we now math the motivating issue (or trust me).I also added a share link so I can refer to searches in the future without screenshots.