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 (4,275 stars) (384 forks)batch import
docshelp wanted

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

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinxMakefile
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
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