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

Fixed the German HTML search again, this time from the 1.7 branch #4871

Merged
merged 1 commit into from
Apr 21, 2018
Merged

Fixed the German HTML search again, this time from the 1.7 branch #4871

merged 1 commit into from
Apr 21, 2018

Conversation

derdennis
Copy link
Contributor

Dear @tk0miya, I recreated my fix from the correct branch. This one should be much easier to merge. Thanks for your patience.

Feature or Bugfix

  • Bugfix

Purpose

We noticed some HTML search glitches in our internal documentation when searching for uppercase parameters like PAR_APP_TITLE or FOO_BAR. Searching for these returned no results while the words were clearly visible on the pages.

We found PR #4396 (Grâce à la France!) and applied the same fix to the German stemmer, regenerated the de.pyc file and everything started to work as expected after the next build html.

Detail

Please see the attached index.txt for a minimal example when used with a freshly created sphinx-quickstart German language (de) project. To reproduce please rename to index.rst, GitHub would not let me upload .rst-files...

Maybe this also applies to more languages than French and German? Is it possible to catch this behaviour via unit tests?

Please apply this PR to the following versions of this fantastic documentation system.

Thank you everybody for your great work.

Dennis

Relates

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tk0miya
Copy link
Member

tk0miya commented Apr 20, 2018

Maybe this also applies to more languages than French and German? Is it possible to catch this behaviour via unit tests?

I don't know other languages, so I can't say right things. But other languages might have same trouble.

@tk0miya
Copy link
Member

tk0miya commented Apr 20, 2018

Unfortunately, there are no unit tests for searching.

@tk0miya tk0miya merged commit 478b313 into sphinx-doc:1.7 Apr 21, 2018
@tk0miya
Copy link
Member

tk0miya commented Apr 21, 2018

Merged.
Thank you for your contribution!

tk0miya added a commit that referenced this pull request Apr 21, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@derdennis derdennis deleted the 1.7 branch April 30, 2018 19:20
derdennis added a commit to derdennis/sphinx that referenced this pull request May 1, 2018
After testing the search for all uppercase words like `PAR_APP_TITLE`
with different settings for `language` in `conf.py` I applied the
same fix as in PR sphinx-doc#4871 to all other languages.

English, French and German were already fixed.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants