wpilibsuite/wpilib-docs

Glossary Usage Check

Aperta

#1883 aperta il 21 ago 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (297 fork)auto 404
ExtensionHelp Wanted

Metriche repository

Star
 (187 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Investiga come creare un'estensione di Sphinx che scansiona i file .rst per i termini del glossario e collega automaticamente la prima occorrenza. Guarda i plugin esistenti per il glossario di Sphinx e la documentazione di Sphinx sulla scrittura di estensioni.
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60