python-sphinx

26calore

6risposta

Sphinx è una libreria Python per generare una buona documentazione da un set di file di testo formattati con la tecnologia ReST. Non lo strumento utilizzato per la ricerca full-text Sono inoltre perfe

18calore

8risposta

Alcuni esempi di personalizzazione della Sfinge?

Ho creato un documento Sfinge usando sphinx-quickstart. Ci sono dei buoni esempi/tutorial sulla personalizzazione del look? In particolare per modificare l'intestazione e aggiungere un logo. Ci sono p

16calore

3risposta

Come caricare la documentazione html generata da sfinge a github?

Ho appena documentato un sacco del mio codice e ho imparato a usare la sfinge per generare la documentazione. Voglio includerlo nella mia pagina del progetto Github ma non so come. Qualcuno conosce tu

20calore

1risposta

Utilizzo della sfinge per auto-documentare una classe python, modulo

Ho installato Sphinx per documentare alcuni moduli python e la classe su cui sto lavorando. Mentre il linguaggio di markup sembra molto carino, non sono riuscito a documentare automaticamente un codic

6calore

1risposta

Come posso rendere leggibile il diagramma dell'ereditarietà di Sphinx?

Simile a this chap's post, sto vedendo Sfinge generare l'output graphviz illeggibile: Come si genera output leggibile? Non succede nulla se aggiungo -Gfontsize=140 Se dico in modo da utilizzare al pos

11calore

1risposta

mostra * solo * docstring nella documentazione di Sphinx

La sfinge ha una funzionalità chiamata automethod che estrae la documentazione dalla docstring di un metodo e la incorpora nella documentazione. Ma non solo incorpora la docstring, ma anche la firma d

9calore

1risposta

Migrazione da Javadoc a Python Documentazione

Quindi mi sono un po 'abituato alla documentazione di stile Javadoc. Guardando attraverso vari esempi di codice Python, sto scoprendo che, a prima vista, la documentazione sembra che manchi di molte i

11calore

3risposta

In Sphinx, c'è un modo per documentare i parametri e dichiararli?

preferisco documentare ogni parametro (se necessario) sulla stessa linea in cui dichiaro il parametro al fine di applicare D.R.Y. Se ho il codice come questo: def foo( flab_nickers, # a series of

11calore

2risposta

Come sovrascrivere le etichette inglesi inserite da Sfinge

Uso lo Sphinx Python documentation generator. Creare documenti PDF è molto facile e semplice, ma ho un problema. Tutti i documenti PDF generati hanno inglese parole come "capitolo", "rilascio" e "part

11calore

2risposta

editor per tabelle in Sfinge/reStructuredText?

Sto cercando di usare Sphinx/reStructuredText per la documentazione, e sembra molto promettente, eccetto che i tavoli sembrano un dolore da fare. C'è un editore che può aiutare?