sphinx-doc/sphinx

testcode directives should support the same options as code-block

Open

#6 858 ouverte le 23 nov. 2019

Voir sur GitHub
 (2 commentaires) (3 réactions) (0 assignés)Python (1 985 forks)batch import
extensionshelp 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

It's relatively easy to switch .. code-block:: directives out for .. testcode:: directives to make sure that documentation is up-to-date with respect to an implementation, which is great.

However, code blocks support several nice options that testcode blocks don't, making it impossible to substitute them 1-for-1 in all situations. For example, options like :caption: and :name: seem both very useful and like they should hopefully be easy to support, and the closer to parity the two directives are, the easier it will be to switch between them as desired.

Guide contributeur

Direction de recherche
Ajoutez les options manquantes (:caption:, :name:) à la directive testcode en étendant la classe de directive et en enregistrant les nouvelles options dans l'extension Sphinx.
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.
2
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
GitPythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60