sphinx-doc/sphinx

Support todo roles in the `sphinx.ext.todo` extension

Open

#6 689 ouverte le 7 sept. 2019

Voir sur GitHub
 (1 commentaire) (3 réactions) (0 assignés)Python (1 985 forks)batch import
awaiting:responseextensions:todohelp 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

Is your feature request related to a problem? Please describe. Sometimes it is convenient to note a todo inline which is not possible using the todo admonition. However there seems to be the todo role. This would require also creating a custom role.

Describe the solution you'd like Using :todo:`todo message` should work the same as using the todo admonition.

Context

https://developer.blender.org/D5664

Guide contributeur

Direction de recherche
Cette demande de fonctionnalité demande un rôle `:todo:` qui fonctionne comme l'avertissement todo en ligne. Pour l'implémenter, examinez `sphinx/ext/todo.py` (l'extension existante) pour comprendre comment la directive todo actuelle est enregistrée. Ensuite, ajoutez une nouvelle définition de rôle en utilisant `roles.register generic role` de Sphinx ou une classe de rôle personnalisée. Référez vous à des rôles similaires dans le cœur de Sphinx (par exemple `:ref:` ou `:doc:`) pour les modèles. La discussion liée des développeurs Blender (D5664) peut fournir un contexte supplémentaire. Comme l'issue est ouverte et qu'aucune PR n'existe, la première étape pourrait être de commenter pour confirmer si cette fonctionnalité est toujours souhaitée, puis d'implémenter le rôle.
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75