sphinx-doc/sphinx

Feature request: support ABNF grammar in productionlist

開放

#4,454 建立於 2018年1月18日

在 GitHub 查看貢獻者指南
 (3 則留言) (1 個反應) (0 位負責人)Python (1,985 個分叉)batch import
help wantedmarkuptype:proposal

倉庫指標

星標
 (5,625 顆星)
PR 合併指標
 (平均合併 10天 11小時) (30 天內合併 11 個 PR)

描述

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

貢獻者指南

研究方向
為 `productionlist` 指令實現 `grammar` 選項，以支援 ABNF（RFC 5234、RFC 4234）和 EBNF（ISO 14977）語法。更新指令解析邏輯以處理新的語法風格並添加測試。
技術棧
python
領域
documentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonSphinx
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70