lark-parser/lark

Docs: Sphinx search doesn't work on generated API

Open

#665 opened on 2020年8月19日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (4,275 stars) (384 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.