wpilibsuite/wpilib-docs

Glossary Usage Check

Ouverte

#1 883 ouverte le 21 août 2022

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (297 forks)auto 404
ExtensionHelp Wanted

Métriques du dépôt

Stars
 (187 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Recherchez comment créer une extension Sphinx qui analyse les fichiers .rst pour les termes du glossaire et lie automatiquement la premiere occurrence. Consultez les plugins de glossaire Sphinx existants et la documentation Sphinx sur l'ecriture d'extensions.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60