wpilibsuite/wpilib-docs

Glossary Usage Check

Aberta

#1.883 aberto em 21 de ago. de 2022

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)JavaScript (297 forks)auto 404
ExtensionHelp Wanted

Métricas do repositório

Stars
 (187 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Create/Find some plugin to scan each source page, and ensure that if a string is in any glossary, the first usage of that string in the .rst file is linked to the glossary. Error out if not

Tentatively, and maybe a bit more advanced.... rather than throwing an error, just automatically treat the first instance of each glossary term as a :term: rather than requiring the author to put it in.

Guia do colaborador

Direção de pesquisa
Investigue como criar uma extensão do Sphinx que examina os arquivos .rst em busca de termos do glossário e vincula automaticamente a primeira ocorrência. Veja os plugins de glossário existentes para o Sphinx e a documentação do Sphinx sobre como escrever extensões.
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60