-
Notifications
You must be signed in to change notification settings - Fork 93
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
Remove examples from documentation search #675
Labels
Comments
Upon further inspection, the cause seems to be that mkdocs does not filter This is one of the commands that produces a lot of spam. The solution is still the same, though: avoid searching notebooks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
It seems like MkDocs material is not very good at isolating notebook sections in searches.
This results in very long search sections that make searching the docs more difficult.
Example: searching
source_unit
will produce a very large search section because the search catches an example notebook (see the little 'ghost' image on the right to get an idea of how long this section is).Related links
ipynb
notebook in the docs.Version
v0.7
Proposed change
I think this issue will pop up quite often because people will often search for a parameters to read what they do, and they are bound to be in some example.
Isolating every single case is probably hard to maintain, so I propose removing examples from the search altogether.
The text was updated successfully, but these errors were encountered: