HTML search does not provide all the results

[MantasVaitkunas]

I did not have any problems till documentation became quite big. At the moment searchindex.js file size is 225.6kb

So now when I'm searching word "Satis" I get only 2 results. I should get at least 16.

I tried to copy document which was not displayed in the search results to new sphinx doc project with less files and search functionality worked perfectly.

Maybe someone had similar issues?

[tk0miya]

Could you give me an example of docs?

I can't reproduce with the following steps:

$ echo Satis >> test.rst
$ make html
# search by "Satis"

[MantasVaitkunas]

Unfortunately documentation is internal and I can't provide an example :(
I tried to reproduce an issue in the random documentation from readthedocs. Not sure if it's the same issue:
http://pop-php-framework.readthedocs.io/en/latest/search.html?q=methods&check_keywords=yes&area=default# It shows only 1 result from "Applications" page.
But this query should show this page too: http://pop-php-framework.readthedocs.io/en/latest/user_guide/images.html?highlight=method

[Blendify]

We have a similar issue on our site search for terms such as "Blender", or "3D View" all of which are included multiple time in the documentation.

We also have a task on our bug tracker for this:

https://developer.blender.org/T49126

[tk0miya]

@MantasVaitkunas Thank you for example. I got it.

This comes from the keywords which is included in some section title does not match to the content part of the documents.
For example, the following case matched to Satis keyword in foo.rst.

$ echo Satis >> foo.rst
$ make html
# search by "Satis"  => matched to foo.rst

But, after adding new section including the keyword "Satis", foo.rst never matches on searching.

$ cat > bar.rst
Satis
=====
$ make clean html
# searcy by "Satis"  => matched only bar.rst

This behavior comes from the changes at #1067 and 054833a.
It says

Modify the indexer to include the words in the section titles in a separate list. Remove these words from the regular list.

I don't know this is good way for searching. But, as a fact, this behavior confuses many people (including me).

[tk0miya]

@tobiasHeinke It seems your problem is not related with this issue.
Please file a new issue and tell us your case in detail.

[TimKam]

@tk0miya Is anybody working on a fix for this?
If not, I might have a look.

[tk0miya]

@TimKam Maybe nobody works about this.
And I don't have enough time for Sphinx.

It would be great if you could help me :-)

[TimKam]

@tk0miya Could you have a look at my PR? :-)

[tk0miya]

Now #2971 is merged. Thank you for reporting.