lark-parser/lark

Docs: Sphinx search doesn't work on generated API

Open

#665 opened on Aug 19, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (509 forks)batch import
docshelp wanted

Repository metrics

Stars
 (5,956 stars)
PR merge metrics
 (Avg merge 41m) (1 merged PR in 30d)

Description

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

Contributor guide

Research direction
Check the Sphinx configuration for search functionality, ensure the search index is properly built and includes all documentation pages.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70