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

Docs: fix inconsistent search results behaviour #16186

Closed
wants to merge 2 commits into from

Conversation

daixiang0
Copy link
Member

@daixiang0 daixiang0 commented Apr 27, 2021

Signed-off-by: Long Dai long0dai@foxmail.com

Commit Message:

Upgrade Sphinx to fix inconsistent search result behaviour.

Fix #15934

Additional Description:

Upstream fix as sphinx-doc/sphinx#8070

Risk Level: Low
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]

@repokitteh-read-only
Copy link

Hi @daixiang0, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #16186 was opened by daixiang0.

see: more, trace.

@repokitteh-read-only repokitteh-read-only bot added the deps Approval required for changes to Envoy's external dependencies label Apr 27, 2021
@repokitteh-read-only
Copy link

CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to (bazel/.*repos.*\.bzl)|(bazel/dependency_imports\.bzl)|(api/bazel/.*\.bzl)|(.*/requirements\.txt)|(.*\.patch).

🐱

Caused by: #16186 was opened by daixiang0.

see: more, trace.

@daixiang0
Copy link
Member Author

Sphinx-tabs only support sphinx<4 :(

Signed-off-by: Long Dai <long0dai@foxmail.com>
Signed-off-by: Long Dai <long0dai@foxmail.com>
@phlax
Copy link
Member

phlax commented May 4, 2021

Sphinx-tabs only support sphinx<4 :(

there is a pr for sphinx-tabs which im expecting will land when sphinx4 comes out of beta

im wondering whether the stemmer fix could be applied outside of the sphinx4 upgrade - altho hopefully it will come out of beta soon

@daixiang0
Copy link
Member Author

@phlax how about apply this patch by hand before deploy docs?

@phlax
Copy link
Member

phlax commented May 6, 2021

how about apply this patch by hand before deploy docs?

it doesnt currently pass CI - besides i would rather wait until sphinx 4 is out of beta before landing that - i think it will make life easier with extensions etc

fixing the stemmer - ie the fix here sphinx-doc/sphinx#8070 - maybe we can include what it does - not sure what is required to do that, or the cleanest way - i can check this further - its possible it could be included using a search adapter

hopefully sphinx4 will be stable soon

@daixiang0
Copy link
Member Author

Got it, let's wait.

@daixiang0
Copy link
Member Author

fixed by db06665

@daixiang0 daixiang0 closed this May 14, 2021
@daixiang0 daixiang0 deleted the fix-search branch May 14, 2021 02:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deps Approval required for changes to Envoy's external dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent Search Results Behaviour
2 participants