sphinx-doc/sphinx

DRY: refactor common functionality in generating index nodes

Open

#2 914 ouverte le 26 août 2016

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
good first issuehelp wantedtype:enhancement

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

I am trying to write a simple extension to automatically add some index nodes. Unfortunately there doesn't seem to be any base function to do that. I found three places where the same essential stuff is being used to add index nodes to the toctree:

So it looks like I have to copy the appropriate implementation pieces of this (add a target node, add an index node, configure each of them).

It would be really useful to refactor the common functionality into a single, simple function that extensions could use.

Guide contributeur

Direction de recherche
Identifiez le modèle commun dans les trois extraits de code référencés et extrayez le dans une seule fonction utilitaire. Assurez vous que la fonction est suffisamment flexible pour être utilisée par les extensions.
Stack technique
python
Domaine
documentation
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75