Docs: improve behavior of Sphinx JS search

Docs: improve behavior of Sphinx JS search

The JS-based search provided in the Sphinx-built HTML docs fail to find all relevant results in many cases, some of which are listed below. This should be improved.

• "Z3" produces no results, but "XZ3" produces several. (This is probably a minimum string length problem.)

• "explain" hits /user/datastores/explaining.html, but does NOT hit user/geoserver.html#geoserver-explain-query, even though both sections explicitly contain the word "explain". (Actually it does, but it does not scroll down to the result when clicked on; see comment below.)

• Does not search for substrings and/or deal with non-alphabetical characters in words (e.g. "geomesa.index.enabled" cannot be found either by searching for "enabled" or for the whole strong).

• Highlight color in search results could be improved

Original JIRA Issue: https://geomesa.atlassian.net/browse/GEOMESA-1657

Key: GEOMESA-1657
Type: Improvement
Priority: Major
Status: To Do
Resolution: Unresolved
Assignee: Matt Zimmerman
Reporter: Matt Zimmerman
Created: Wed, 1 Feb 2017 10:37:28 -0500
Updated: Tue, 27 Mar 2018 16:17:45 -0400

Comments:

557058:b766f3ff-5b6c-4d83-a9a1-5b2a1b6c700c (Wed, 1 Feb 2017 11:21:46 -0500):

Actually, the search on "explain" is getting the /user/geoserver.html page; it's the first result. However, the problem is that the section that contains the word is several subsections down, but clicking on the title in the search results puts you at the top of the page, and it's not immediately obvious that the section that you want is present.

Start with the Sphinx-built HTML docs and reproduce the listed searches, including “Z3,” “explain,” and “geomesa.index.enabled.” Check the JS-based search results for minimum-length handling, substrings, non-alphabetical words, scrolling to the matching section, and highlight color; done means these cases return and navigate to the relevant content.