sphinx-doc/sphinx

Can't search numbers, codes, digits...

Open

#776 opened on 2015年1月2日

GitHub で見る
 (12 comments) (1 reaction) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
builder:htmlhelp wantedtype:enhancement

説明

Hi,

Since I've been writing documentation that includes some digital codes, I wanted to be able to retrieve documents that contain these codes. But it failed. I've noticed that the search tool is not able to retrieve documents containing numbers.

How to reproduce it:

  • create a simple sphinx documentation using //sphinx-quickstart//,
  • edit the index.rst page and add //"Hi! I'm 1234"// in it.
  • build it (make html)
  • serve the page through a simple webserver (I've used //"python -m SimpleHTTPServer"//)
  • search "1234" via the search form.
  • no result.

maybe these string are not considered as "words", and so they're not included in the index?

コントリビューターガイド

技術スタック
python
領域
search
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
Examine the search indexing code in sphinx/search/. The issue states that numbers are not indexed as words. Look for a tokenizer or analyzer that filters out digits. Modify the code to include numeric tokens. Check existing comments and any linked PRs for proposed solutions. The fix likely involves a small change to a regex pattern or a configuration option.