view.py icon indicating copy to clipboard operation
view.py copied to clipboard

Fix MkDocs Search

Open ZeroIntensity opened this issue 1 year ago • 1 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Current Behavior

If you use the "Search documentation" feature on the docs, some of the results will appear as HTML elements (i.e. their title is <code>...).

Expected Behavior

It should instead display just a title (or not display it all).

Steps To Reproduce

Search "hello" on the docs, for example.

Anything else

This is likely due to mkdocstrings messing with TOC and the search displaying it with the extra mkdocstrings tag. If anyone is more experienced with MkDocs themes or mkdocstrings, feel free to work on this.

ZeroIntensity avatar Feb 05 '24 14:02 ZeroIntensity

Relevant PR: https://github.com/mkdocs/mkdocs/pull/3560.

pawamoy avatar Feb 05 '24 14:02 pawamoy

This is no longer relevant as of the switch to mkdocs-material

ZeroIntensity avatar May 29 '24 12:05 ZeroIntensity