sphinx-doc/sphinx

Feature request: support ABNF grammar in productionlist

Offen

#4.454 geöffnet am 18.01.2018

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (1.985 Forks)batch import
help wantedmarkuptype:proposal

Repository-Metriken

Stars
 (5.625 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 11h) (11 gemergte PRs in 30 T)

Beschreibung

Feature

Provide support for Augmented Backus Naur Form [rfc5234] syntax in production list. The grammar option could have the following values:

  • abnf-5234 for rfc5234
  • abnf, alias for abnf-5234
  • abnf-4234 for rfc4234
  • ebnf for ISO-14977 (when supported)
  • sphinx (default)

Sample

.. productionlist::
  :grammar: abnf-5234

  UPPERCASE-ALPHA = %x41-5A ; A-Z
  LOWERCASE-ALPHA = %x61-7A ; a-z

Contributor Guide

Research-Richtung
Implementieren Sie die Option `grammar` für die Direktive `productionlist`, um ABNF (RFC 5234, RFC 4234) und EBNF (ISO 14977) Syntax zu unterstützen. Aktualisieren Sie die Parsing Logik der Direktive, um neue Grammatikstile zu verarbeiten, und fügen Sie Tests hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70