sphinx-doc/sphinx

Feature request: support ABNF grammar in productionlist

Aberta

#4.454 aberto em 18 de jan. de 2018

Ver no GitHubGuia do colaborador
 (3 comentários) (1 reação) (0 responsável)Python (1.985 forks)batch import
help wantedmarkuptype:proposal

Métricas do repositório

Stars
 (5.625 estrelas)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Implemente a opção `grammar` para a diretiva `productionlist` para oferecer suporte à sintaxe ABNF (RFC 5234, RFC 4234) e EBNF (ISO 14977). Atualize a lógica de análise da diretiva para lidar com novos estilos gramaticais e adicione testes.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70