sphinx-doc/sphinx

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

Open

#2909 aperta il 26 ago 2016

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
help wantedtype:docs

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Trova la documentazione ufficiale dell'API di doctree o il codice sorgente in docutils e aggiungi un collegamento nella sezione degli eventi dell'API dell'applicazione Sphinx.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90