restructuredtext

7calore

1risposta

Non posso usare Ref con un'etichetta usando la Sfinge doc

Ho un problema con l'uso della funzione Ref di Sphinx-doc, ho messo un'etichetta sopra un paragrafo e poi provo a collegarmi a quell'etichetta da un altro documento ma all'interno dello stesso progett

15calore

3risposta

descrizione multilinea di una descrizione dei parametri in python docstring

Quindi, reStructuredText è the recommended way per Python codice documentazione, se si tenta già abbastanza difficile, si può find in the sphinx documentation come normalizzare la documentazione firma

5calore

2risposta

Aggiungi una classe a un tavolo in Sfinge?

Ho una tabella in primo luogo, e voglio aggiungere una classe ad esso, durante la compilazione in HTML con Sphinx. Secondo the docs, aggiungere una direttiva .. class:: prima che la tabella aggiunga l

7calore

1risposta

Come ridimensionare le immagini incluse nelle pagine di documentazione di GitHub?

Ho una pagina README.rst su GitHub ma non sono in grado di specificare la dimensione delle immagini collegate e in realtà non voglio includerle nel mio repository. Vedi https://github.com/pycontribs/j

5calore

3risposta

Collegamento ipertestuale interno in testo ristrutturato con testo personalizzato

So come creare un collegamento ipertestuale esterno con testo personalizzato. `My cool link <http://www.asdf.com>`_ Ma voglio collegarmi a un riferimento interno. .. _foo: Lorem ipsum dolor sit am

5calore

2risposta

Come posso collegare/fare riferimento a un altro file di ripristino nella documentazione?

Non ho semplicemente idea di come posso collegarmi a un altro documento nel file di ripristino. Desidero collegare un file denominato install.rst alla mia guida rapida in un paragrafo. Non so come pos

6calore

2risposta

Come documentare: rtype: per una funzione che restituisce più tipi di dati possibili?

In una documentazione di Python come si dovrebbe documentare :rtype: per una funzione che può restituire più tipi di dati possibili? Ad esempio, se una funzione può restituire defaultdict OR dict O li

7calore

1risposta

Immagine in README.rst non visualizzata in pypi

Vorrei che un'immagine visualizzata nel mio file README.rst venga visualizzata quando carico il mio pacchetto su PyPI. Nel mio README ho: .. image:: example-python.png :height: 100px :width:

6calore

1risposta

Aggiungere una classe CSS per un collegamento in RST

ho un link nel mio file .rst che assomiglia Click me! <../link_reference.html> Questo rende come Click me !. Tuttavia, voglio aggiungere una classe CSS, in modo che assomigli a Click me !. ho aggiun

5calore

1risposta

Qual è la differenza tra le direttive di codice e blocco di codice in ReST?

In ogni renderer che ho provato, code e code-block sembrano avere lo stesso risultato esatto: un blocco di codice. Entrambi generano la stessa identica html - tra classi e tag genere (usando credo che