Skip to content
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

Open
irm-codebase opened this issue Sep 8, 2024 · 1 comment
Open

Remove examples from documentation search #675

irm-codebase opened this issue Sep 8, 2024 · 1 comment

Comments

@irm-codebase
Copy link
Contributor

irm-codebase commented Sep 8, 2024

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).
image

Related links

  • Any 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.

@irm-codebase
Copy link
Contributor Author

irm-codebase commented Sep 8, 2024

Upon further inspection, the cause seems to be that mkdocs does not filter xarray dataset printouts well.

This is one of the commands that produces a lot of spam.
In combination with def_dict in the model data attributes (see #639), it leads bad searches in the documents.

image

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
Projects
None yet
Development

No branches or pull requests

1 participant