sphinx-doc/sphinx

Feature request: support ABNF grammar in productionlist

Open

#4,454 opened on Jan 18, 2018

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (1,985 forks)batch import
help wantedmarkuptype:proposal

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

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 direction
Implement the `grammar` option for the `productionlist` directive to support ABNF (RFC 5234, RFC 4234) and EBNF (ISO 14977) syntax. Update the directive parsing logic to handle new grammar styles and add tests.
Tech stack
python
Domain
documentation
Issue type
Feature
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.
Half day
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
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70