lark-parser/lark

Docs: Sphinx search doesn't work on generated API

Open

#665 geöffnet am 19. Aug. 2020

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (384 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (4.275 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 41m) (1 gemergte PR in 30 T)

Beschreibung

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-Richtung
Überprüfen Sie die Sphinx Konfiguration für die Suchfunktion und stellen Sie sicher, dass der Suchindex ordnungsgemäß erstellt wurde und alle Dokumentationsseiten enthält.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70