lark-parser/lark

Docs: Sphinx search doesn't work on generated API

Open

#665 建立於 2020年8月19日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Python (4,275 star) (384 fork)batch import
docshelp wanted

描述

For example, this page:

https://lark-parser.readthedocs.io/en/latest/search.html?q=maybe_placeholders

Doesn't find this mention:

https://lark-parser.readthedocs.io/en/latest/classes.html (search for maybe_placeholders)

Also, partial search doesn't work. Searching for maybe_ gives no results.

@chsasank

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonSphinxMakefile
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
55
研究方向
The issue is that the Sphinx search does not find words like 'maybe placeholders' on the generated API documentation. Investigate the Sphinx configuration in 'docs/conf.py' and the build process. Ensure that the search index is generated correctly when building the API docs. Consider testing with different Sphinx versions and checking if the search index includes the API reference. Also, verify the ReadTheDocs build settings if applicable.