python-sphinx

5calore

2risposta

Sphinx - Moduli, classi e funzioni Python Documentazione

Sto cercando di documentare il mio piccolo progetto attraverso la sfinge che ultimamente sto cercando di familiarizzare. Ho letto alcuni tutorial e documentazione sulla sfinge ma non sono riuscito a f

23calore

5risposta

Riferimenti a cifre con numeri in Sfinge e Testo ricostruito

Quando si scrive RST che verrà elaborato con Sphinx, non è possibile ottenere l'output di Sphinx LaTeX per utilizzare i numeri di figura quando si fa riferimento alle cifre. Per esempio, questo codice

18calore

3risposta

Qual è la relazione tra docutils e Sphinx?

Sembra che ci sia una pletora di strumenti di documentazione per Python. Un altro che ho incontrato è epydoc. Sembra che Sphinx sia lo standard di fatto, perché è usato per generare i documenti uffici

5calore

1risposta

Utilizzando ReStructuredText e Sfinge per includere un file preformattato

Sto cercando di fare questo lavoro frammento: Version History --------------- These are the versions over time:: .. include:: ../../CHANGES.txt Cioè, utilizzare la direttiva includere in mo

5calore

2risposta

Nella Sfinge, posso registrare un gruppo di parole chiave che dovrebbero sempre essere tradotte in link?

Le mie stringhe doc hanno riferimenti ad altre classi python che ho definito. Ogni volta che Sphinx incontra una di queste classi, voglio che inserisca un link alla documentazione per quell'altra clas

5calore

1risposta

Sfinge: articolo indicizzato con riferimento incrociato

Come posso eseguire il rimando incrociato di un articolo indicizzato all'interno di un documento reStructuredText? Ad esempio, come posso riferimento incrociato SectionB: .. index:: pair: Section

10calore

3risposta

In che modo il sito Web Python genera la sua documentazione online?

Creato con Sfinge 0.6.5. So che la documentazione di Python utilizza reStructuredText, ma ha diverse sezioni come http://docs.python.org/whatsnew/2.6.html e http://docs.python.org/tutorial/index.html.

9calore

5risposta

Converti tabelle prima in LaTeX

Ho alcuni file .rst e li converto in file .tex utilizzando un convertitore standard di sphinx. In alcuni .rst devo tabelle con larghezza speciale come: tavoli .. list-table:: :widths: 50 50 Il

112calore

4risposta

L'autodoc di Sphinx non è abbastanza automatico

Sto provando a usare Sphinx per documentare un progetto di oltre 5.000 linee in Python. Ha circa 7 moduli base. Per quanto ne so, Per poter utilizzare autodoc ho bisogno di scrivere codice come questo

12calore

3risposta

Sphinx, reStructuredText mostra/nascondi frammenti di codice

Ho documentato un pacchetto software utilizzando Sphinx e reStructuredText. All'interno dei miei documenti ci sono alcuni frammenti di codice lunghi. Voglio essere in grado di averli nascosti come pre