search

mgeier / insipid-sphinx-theme

:yawning_face: An insipid theme for the Sphinx documentation generator.
https://insipid-sphinx-theme.readthedocs.io/
BSD 2-Clause "Simplified" License
38 stars 4 forks source link

DOC: better escaping for utteranc.es issue-term #123

Closed mgeier closed 1 year ago

mgeier commented 1 year ago

This is maybe not strictly necessary in our docs, but if a page name is contained in the beginning of another page name (e.g. table and table-tennis), the comments of the shorter name will incorrectly point to the comments of the longer one.

mgeier commented 1 year ago

After some experimenting, I found that the hyphens (and similar characters) are the actual problem. Substrings don't generally match, except when they are flanked by those special characters.

Adding a suffix only partially fixes the problem, hyphens would still act as search term separators.

I think a better solution is to replace hyphens et al., a suffix is not needed anymore.