python-sphinx

6calore

1risposta

Come posso ottenere lo sfarfallio automatico per visualizzare i documenti per gli attributi di un'istanza?

Tutti gli altri tipi (classi, proprietà, metodi, ecc.) Funzionano bene, ma quando la ricombina automatica raggiunge gli attributi di istanza genera un errore "WARNING: failed to import AClass.a". La c

8calore

2risposta

Può la funzione di documento napoleone sfinge che restituisce più argomenti?

Sto cercando di utilizzare lo stile del codice Google per documentare una funzione che uso quindi con sfinge l'estensione napoleon per creare la documentazione. La funzione è inusuale in quanto restit

5calore

2risposta

Errore LaTeX con Sfinge: file `titlesec.sty' non trovato

Durante il tentativo di generare la documentazione in PDF di un progetto Sfinge, ottengo questo: ! LaTeX Error: File `titlesec.sty' not found. Type X to quit or <RETURN> to proceed, or enter new na

6calore

1risposta

Sfinge: Riprendi lista la numerazione dopo una sezione nota

consideri l'elenco seguente in ReStructuredText: Broken list example ------------------- #. First do spam #. Then do ``eggs`` .. note:: Nobody expects the Spanish Inquisistion #. The

10calore

3risposta

Personalizza i modelli per `sphinx-apidoc`

Ho recentemente provato a utilizzare sphinx-apidoc da Sphinx per aiutare a generare reStructuredText specifico della Sfinge dall'API di un progetto Python. Tuttavia, il risultato che sto ottenendo è:

8calore

2risposta

Un letterale "*" in reStructuredText

sto guardando questo frammento di codice: def ook(*args): """Some silly function. :param *args: Optional arguments. """ ... E non appena corro Sfinge, ottengo l'errore oh-così u

13calore

2risposta

È possibile nascondere gli argomenti della funzione Python in Sphinx?

Supponiamo che io ho la seguente funzione che viene documentata nel Numpydoc style, e la documentazione è generata automaticamente con il Sphinxautofunction directive: def foo(x, y, _hidden_argument=N

5calore

1risposta

Come posso usare l'unica direttiva in linea usando il ruolo in python-sphinx?

In python-sfinge c'è lo only directive, che può essere usato per influenzare condizionalmente il documento in base alla sua uscita. Ad esempio il testo appare solo in html o latex. Si usa in questo mo

5calore

1risposta

Scala svg figura in output HTML della Sfinge (riposo)

Ho una figura nel testo ristrutturata utilizzando una direttiva scala come segue: .. figure:: images/my_image.svg :scale: 150 % L'immagine è perfettamente OK nella output HTML della sfinge, sal

8calore

1risposta

Come posso avere più versioni del mio documento con sfinge?

Come la documentazione di python o django, come posso avere più versioni del mio documento con sfinge? ho salvato il mio doc su git, e voglio che il mio utente sia in grado di vedere la documentazione