Skip to content

#1618 make search results reader friendly #4022

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.

Sign up for GitHub

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

Merged
TimKam merged 8 commits into from
Aug 29, 2018
Merged

#1618 make search results reader friendly #4022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
14e39ad
#1618 make search results reader friendly
TimKam Aug 23, 2017
e1ba695
Merge branch 'master' into 1618-make-search-results-reader-friendly
TimKam Jul 16, 2018
6bbfc3b
#1618 remove obsolete warning from doc
TimKam Jul 17, 2018
1c0cc20
#1618 use file suffix config variable instead of '.html'
TimKam Jul 17, 2018
26bd565
Merge branch 'master' into 1618-make-search-results-reader-friendly
TimKam Aug 27, 2018
2aca8d0
Merge remote-tracking branch 'upstream/master' into 1618-make-search-…
TimKam Aug 28, 2018
cbf2d8e
#1618 document change
TimKam Aug 28, 2018
1a80152
Merge branch 'master' into 1618-make-search-results-reader-friendly
TimKam Aug 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Deprecated

Features added
--------------
* #1618: The search results preview of generated HTML documentation is
reader-friendlier: instead of showing the snippets as raw reStructuredText
markup, Sphinx now renders the corresponding HTML. This means the Sphinx
extension `Sphinx: pretty search results`__ is no longer necessary. Note that
changes to the search function of your custom or 3rd-pary HTML template might
overwrite this improvement.

__ https://github.com/sphinx-contrib/sphinx-pretty-searchresults

* #4182: autodoc: Support :confval:`suppress_warnings`

Expand Down
6 changes: 0 additions & 6 deletions doc/usage/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1108,12 +1108,6 @@ that use Sphinx's HTMLWriter class.
If true, the reST sources are included in the HTML build as
:file:`_sources/{name}`. The default is ``True``.

.. warning::

If this config value is set to ``False``, the JavaScript search function
will only display the titles of matching documents, and no excerpt from
the matching contents.

.. confval:: html_show_sourcelink

If true (and :confval:`html_copy_source` is true as well), links to the
Expand Down
17 changes: 11 additions & 6 deletions sphinx/themes/basic/static/searchtools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ var Search = {
_queued_query : null,
_pulse_status : -1,

htmlToText : function(htmlString) {
var htmlElement = document.createElement('span');
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
return docContent.textContent || docContent.innerText;
},

init : function() {
var params = $.getQueryParameters();
if (params.q) {
Expand Down Expand Up @@ -260,11 +268,7 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
if (suffix === undefined) {
suffix = '.txt';
}
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
Expand Down Expand Up @@ -457,7 +461,8 @@ var Search = {
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
Expand Down