sphinx-doc/sphinx

Feature request: support ABNF grammar in productionlist

Aperta

#4454 aperta il 18 gen 2018

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)Python (1985 fork)batch import
help wantedmarkuptype:proposal

Metriche repository

Star
 (5625 stelle)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Implementa l'opzione `grammar` per la direttiva `productionlist` per supportare la sintassi ABNF (RFC 5234, RFC 4234) ed EBNF (ISO 14977). Aggiorna la logica di parsing della direttiva per gestire i nuovi stili grammaticali e aggiungi test.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70