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.
Docs: Sphinx search doesn't work on generated API · lark-parser/lark#665 | Good First Issue