sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3 898 ouverte le 29 juin 2017

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)Python (1 985 forks)batch import
apidomainhelp wantedtype:proposal

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

The current Sphinx api regarding extending domains is very confusing: why is there add_role_to_domain(), and add_directive_to_domain() but no add_object_type_to_domain() ? So if someone wants to add new object types to existing domain, the proper way now is to override the whole domain and add new types in the new class. It's also confusing because developer may mix inheritance-based customization and app-method-based customization. Having to use one, or another, but not both could improve the clarity.

Guide contributeur

Direction de recherche
Étudiez les implémentations existantes de add role to domain() et add directive to domain() dans le code source de Sphinx, puis ajoutez une nouvelle méthode add object type to domain() suivant le même modèle.
Stack technique
python
Domaine
documentationdeveloper experience
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx development
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60