Search: Missing match highlights in search results

[michael-wisely-gravwell]

The Problem

I recently migrated a project from pydata-sphinx-theme 0.11.0 to 0.15.2.

On 0.11.0, I was used to seeing the little match context with each page link featuring highlights on matches.

On 0.15.2, however, I don't see the match contexts at all, but I do see lot of errors logged by searchtools.js.

It would appear that searchtools.js is looking for an element with the selector [role="main"], and it's not finding it.

A Workaround

Adding this to my layout.html appears to fix the issue for me:

{% block docs_body %}
  {% include "components/searchbox.html" %}
  <article class="bd-article" role="main">
    {% block body %}{% endblock %}
  </article>
{% endblock docs_body %}

That said, I'm not totally certain if docs_body is the right place to put role="main". I decided to try adding it there because that's where it's located in v0.11.0

[drammock]

the role="main" was removed in #1454 for screen reader compatibility. @gabalafou can you look?

[gabalafou]

Thanks @michael-wisely-gravwell for submitting such a thorough issue (sorry for the turbulence!) and thanks @drammock for linking #1454. I've submitted a fix, #1678.