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

The highlighted search terms in the online refman are annoying #15778

Closed
ana-borges opened this issue Mar 7, 2022 · 1 comment · Fixed by #17772
Closed

The highlighted search terms in the online refman are annoying #15778

ana-borges opened this issue Mar 7, 2022 · 1 comment · Fixed by #17772
Assignees
Labels
kind: documentation Additions or improvement to documentation. kind: wish Feature or enhancement requests.
Milestone

Comments

@ana-borges
Copy link
Contributor

Description of the problem

The highlighted text can be very annoying, for example: https://coq.inria.fr/refman/user-extensions/syntax-extensions.html?highlight=notation#coq:cmd.Notation

Note that the URL itself mentions the highlighting, and manually editing the URL gets rid of it. I wish there was a better way though.

We identified two possible avenues towards getting rid of it in this zulip discussion:

  1. Include a button to hide the highlighting, like this. Sphinx has this feature, but not Read the Docs, and it seems it will continue not having it:
    A button for removing highlight content from the page readthedocs/sphinx_rtd_theme#816
    See also Proof of Concept: Hide search matches readthedocs/sphinx_rtd_theme#876
    This hypothetical button could perhaps be implemented on Coq's side.

  2. Deploy the refman with Sphinx >= 4.5.0 in order to take advantage of Implement new search shortcuts. sphinx-doc/sphinx#9337. Note that 4.5.0 is the dev version at the time of writing.

cc. @cpitclaudel

@ana-borges ana-borges added the kind: wish Feature or enhancement requests. label Mar 7, 2022
@Alizter Alizter added the kind: documentation Additions or improvement to documentation. label Apr 11, 2022
@Alizter Alizter added this to Infrastructure in User documentation May 17, 2022
@ana-borges ana-borges self-assigned this Jun 28, 2023
@ana-borges
Copy link
Contributor Author

Sphinx 4.5 is now more than a year old, so I think it's reasonable to go with that option.

@ana-borges ana-borges mentioned this issue Jun 28, 2023
2 tasks
@coqbot-app coqbot-app bot added this to the 8.19+rc1 milestone Jun 30, 2023
@Zimmi48 Zimmi48 modified the milestones: 8.19+rc1, 8.18+rc1 Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Additions or improvement to documentation. kind: wish Feature or enhancement requests.
Projects
Archived in project
User documentation
  
Infrastructure
Development

Successfully merging a pull request may close this issue.

3 participants