On Tue, Feb 9, 2021 at 3:18 PM Denis Bitouzé wrote:
>
> Hi,
>
> the Sphinx-doc documentation has the nice "Hide Search Matches" feature,
> that one can see for instance at the bottom right of:
>
>   ┌────
>   │ https://www.sphinx-doc.org/en/master/index.html?highlight=Sphinx
>   └────
>
> the link of which being:
>
>   ┌────
>   │ javascript:Documentation.hideSearchWords()
>   └────
>
> How could I add this feature to my own Sphinx instance?

This feature is always available, but sadly, many Sphinx HTML themes
do not provide the "Hide Search Matches" link.

I have suggested to add this to the sphinx_rtd_theme, but this hasn't
happened (yet?):
https://github.com/readthedocs/sphinx_rtd_theme/pull/876

In my own theme, I have decided to put the "Hide Search Matches" link
into the header bar, see for example
https://insipid-sphinx-theme.readthedocs.io/en/0.2.2/configuration.html?highlight=Sphinx#sphinx-settings

You can try which themes support this at https://sphinx-themes.org/.

cheers,
Matthias

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFesC-fHrAJrqJDBm2_%2BX%2Bt2HAG%2BXbx-7KKtx1-duu5n%2BQfwyA%40mail.gmail.com.

Reply via email to