HTML search does not work

Bug #1805518 reported by Kristal Dale on 2018-11-28
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-doc-tools
Undecided
Unassigned

Bug Description

The static search returns no results for all queries. This issue appears on many sites using the OpenStack docs theme and the starlingX theme. This is reproducible in the openstackdocstheme demo docs.

To see the issue, go to:
- https://docs.starlingx.io/stx-metal/search.html
- https://docs.openstack.org/project-team-guide/search.html
- https://docs.openstack.org/swift/latest/search.html

Searching gives no results - just hangs with the rotating ellipses.

It appears to be a known issue with Sphinx moving from version 1.7 to 1.8, where classes/js needed by the static search are not loaded by default (relies on the custom theme to load the needed js). Other custom Sphinx themes are seeing similar issues: https://github.com/sphinx-doc/sphinx/issues/5460

Looking at errors in the page when search is executed shows that indeed a js file is not found.

This issue is apparently fixed with Sphinx 1.8.3:
https://www.sphinx-doc.org/en/master/changes.html#release-1-8-3-in-development

Near term, can add the missing js file to the openstackdocsthem (documentation_options.js)

Andreas Jaeger (jaegerandi) wrote :

This has been fixed with newer openstackdocstheme

Changed in openstack-doc-tools:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers