sphinx-doc/sphinx

documentation: please link "doctree" to the doctree API documentation (or source code if none is found)

Open

#2 909 ouverte le 26 août 2016

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (1 985 forks)batch import
help wantedtype:docs

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 Sphinx Application API does a good job of covering various methods.

In the "core events" section, there are, however, several references to doctree from docutils, and it is maddeningly difficult to figure out what can be done with this object, since I have no experience with docutils and can't find any documentation about the Python API, just the XML structure here http://docutils.sourceforge.net/docs/ref/doctree.html

Please link doctree to an appropriate page in docutils.

Guide contributeur

Direction de recherche
Trouvez la documentation officielle de l'API doctree ou le code source dans docutils et ajoutez un lien dans la section des événements de l'API de l'application Sphinx.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90