Skip to content
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.

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

html search: Do not load language_data.js in non-search pages #1021

Merged
merged 1 commit into from
Dec 2, 2020

Conversation

Blendify
Copy link
Member

@Blendify Blendify commented Dec 1, 2020

This is needed with changes in sphinx 3.4.x.

See sphinx-doc/sphinx@f5289bb

@Blendify Blendify requested a review from a team December 1, 2020 20:18
@stsewd stsewd merged commit 24f8e31 into master Dec 2, 2020
@stsewd stsewd deleted the Blendify/html-search-js branch December 2, 2020 16:00
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Jan 11, 2021
Sphinx stopped loading language_data.js globally in 3.4.
This file now has to be loaded explicitly on the search page.

See

- sphinx-doc/sphinx#8445
- readthedocs/sphinx_rtd_theme#1021
mtreinish added a commit to mtreinish/qiskit_sphinx_theme that referenced this pull request Jun 1, 2021
This commit fixes an issue with search.html when building with newer
versions of sphinx. Since the release of sphinx 3.4.0 the search bar
has not worked when using the qiskit_sphinx_theme package. This is
because we were not loading a required script to make the search bar
work with the new sphinx theme. This was done in the upstream
pytorch_sphinx_theme package with:

pytorch/pytorch_sphinx_theme@d033830

which looks like it was itself ported from the sphinx-rtd-theme package
which fixed this same issue with:

readthedocs/sphinx_rtd_theme#1021

This is just porting that change to qiskit_sphinx_theme which at least
fixes the search bar in local builds for me.
mtreinish added a commit to Qiskit/qiskit_sphinx_theme that referenced this pull request Jun 2, 2021
This commit fixes an issue with search.html when building with newer
versions of sphinx. Since the release of sphinx 3.4.0 the search bar
has not worked when using the qiskit_sphinx_theme package. This is
because we were not loading a required script to make the search bar
work with the new sphinx theme. This was done in the upstream
pytorch_sphinx_theme package with:

pytorch/pytorch_sphinx_theme@d033830

which looks like it was itself ported from the sphinx-rtd-theme package
which fixed this same issue with:

readthedocs/sphinx_rtd_theme#1021

This is just porting that change to qiskit_sphinx_theme which at least
fixes the search bar in local builds for me.
JulianGro added a commit to JulianGro/vircadia-docs-sphinx that referenced this pull request Jun 15, 2021
bdrung pushed a commit to bdrung/salt that referenced this pull request Oct 13, 2021
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
bdrung pushed a commit to bdrung/salt that referenced this pull request Oct 14, 2021
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
imrehg added a commit to imrehg/faculty-sphinx-theme that referenced this pull request Dec 16, 2021
The search issue was due to Sphinx changes and fixed in readthedocs/sphinx_rtd_theme#1021
that was released in the 0.5.1 version of the theme, so that's the earliest we
can bump to to have functioning search again.

Looking at versions since then, the latest (1.0.0) version seems
to have identical results in the compiled documentation, so
bumping to that version is likely more future proof.
imrehg added a commit to imrehg/faculty-sphinx-theme that referenced this pull request Dec 16, 2021
The search issue was due to Sphinx changes and fixed in readthedocs/sphinx_rtd_theme#1021
that was released in the 0.5.1 version of the theme, so that's the earliest we
can bump to to have functioning search again.

Looking at versions since then, the latest (1.0.0) version seems
to have identical results in the compiled documentation, so
bumping to that version is likely more future proof.
imrehg added a commit to imrehg/faculty-sphinx-theme that referenced this pull request Dec 16, 2021
The search issue was due to Sphinx changes and fixed in readthedocs/sphinx_rtd_theme#1021
that was released in the 0.5.1 version of the theme, so that's the earliest we
can bump to to have functioning search again.

Looking at versions since then, the latest (1.0.0) version seems
to have identical results in the compiled documentation, so
bumping to that version is likely more future proof.
ryan-roemer pushed a commit to ryan-roemer/sphinx-bootstrap-theme that referenced this pull request Jan 24, 2022
Our version of readthedocs/sphinx_rtd_theme#1021 to fix issues due to sphinx-doc/sphinx#8623, i.e., `search.html` not actually searching due to `Uncaught ReferenceError: Stemmer is not defined` in Sphinx 3.4+.

Closes #214 
Closes #220
lunkwill42 added a commit to Uninett/nav that referenced this pull request Mar 25, 2022
Analogue to changes made in the Read The Docs theme in
readthedocs/sphinx_rtd_theme#1021
psavery added a commit to psavery/paraview-docs that referenced this pull request Mar 25, 2022
Newer versions of sphinx (starting with [this commit](sphinx-doc/sphinx@f5289bb))
no longer automatically load the `language_data.js` file. This would
cause the `sphinx_rtd_theme` to have an error when attempting to search
that stated `Uncaught ReferenceError: Stemmer is not defined`. The
`Stemmer` is a class normally defined in the `language_data.js` file.

Newer versions of `sphinx_rtd_theme` load the `language_data.js` file
in manually, starting from [this PR](readthedocs/sphinx_rtd_theme#1021).

Load the language data in via a similar setup so that the search
works for v5.6.2 and v5.7.0.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com>
psavery added a commit to psavery/paraview-docs that referenced this pull request Mar 25, 2022
Newer versions of sphinx (starting with [this commit](sphinx-doc/sphinx@f5289bb))
no longer automatically load the `language_data.js` file. This would
cause the `sphinx_rtd_theme` to have an error when attempting to search
that stated `Uncaught ReferenceError: Stemmer is not defined`. The
`Stemmer` is a class normally defined in the `language_data.js` file.

Newer versions of `sphinx_rtd_theme` load the `language_data.js` file
in manually, starting from [this PR](readthedocs/sphinx_rtd_theme#1021).

Load the language data in via a similar setup so that the search
works for v5.6.2 and v5.7.0.

The latest `language_data.js` file was used.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com>
ix5 added a commit to ix5/isso that referenced this pull request Mar 28, 2022
A few things got refactored in sphinx, especially for 4.x.
Therefore, use provided helpers.

As a reference for the future, always look at what the
"basic" sphinx theme (bundled as `sphinx/themes/basic`)
does.

See:
- sphinx-doc/sphinx@a957d6f710
- sphinx-doc/sphinx#4916
- sphinx-doc/sphinx#4915
- readthedocs/sphinx_rtd_theme#1021
ix5 added a commit to ix5/isso that referenced this pull request Mar 28, 2022
A few things got refactored in sphinx, especially for 4.x.
Therefore, use provided helpers.

As a reference for the future, always look at what the
"basic" sphinx theme (bundled as `sphinx/themes/basic`)
does.

See:
- sphinx-doc/sphinx@a957d6f710
- sphinx-doc/sphinx#4916
- sphinx-doc/sphinx#4915
- readthedocs/sphinx_rtd_theme#1021
bdrung pushed a commit to bdrung/salt that referenced this pull request Apr 15, 2022
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
Gbp-Pq: Name ensure-searchtools.js-gets-included.patch
bdrung pushed a commit to bdrung/salt that referenced this pull request Apr 16, 2022
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
Gbp-Pq: Name ensure-searchtools.js-gets-included.patch
bdrung pushed a commit to bdrung/salt that referenced this pull request Apr 16, 2022
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
Gbp-Pq: Name ensure-searchtools.js-gets-included.patch
oleksiyskononenko added a commit to h2oai/datatable that referenced this pull request Jul 20, 2022
Adjust our custom theme in a way similar to `sphinx_rtd_theme`, see  readthedocs/sphinx_rtd_theme#1021. This fixes the search functionality for sphinx `4.*`. We can take care of sphinx `5.*`, that was recently released later, if needed.

Closes #3299
samukweku pushed a commit to h2oai/datatable that referenced this pull request Aug 4, 2022
Adjust our custom theme in a way similar to `sphinx_rtd_theme`, see  readthedocs/sphinx_rtd_theme#1021. This fixes the search functionality for sphinx `4.*`. We can take care of sphinx `5.*`, that was recently released later, if needed.

Closes #3299
samukweku pushed a commit to h2oai/datatable that referenced this pull request Aug 10, 2022
Adjust our custom theme in a way similar to `sphinx_rtd_theme`, see  readthedocs/sphinx_rtd_theme#1021. This fixes the search functionality for sphinx `4.*`. We can take care of sphinx `5.*`, that was recently released later, if needed.

Closes #3299
bdrung pushed a commit to bdrung/salt that referenced this pull request Nov 30, 2022
Searchtools did not get included with Debian > stretch and
Sphinx > 1.6.7.

Sphinx 3.4.0 also needs `language_data.js` to properly search.
See readthedocs/sphinx_rtd_theme#1021

`searchtools.js` and `language_data.js` are only needed by
`search.html`. So maybe better just add `search.html` to the template.

Forwarded: no
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
Gbp-Pq: Name ensure-searchtools.js-gets-included.patch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants