sphinx-doc/sphinx

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

Open

#776 建立於 2015年1月2日

在 GitHub 查看
 (12 留言) (1 反應) (0 負責人)Python (5,625 star) (1,985 fork)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
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.