python-sphinx

12calore

4risposta

Ho un sacco di classi che usano "speciali-metodi": class Foo(object): "Foo docstring" attr1 = "Attribute!" #: first attribute attr2 = "Another Attribute!" #: second attribute def

16calore

3risposta

Come documentare un'eccezione usando Sfinge

Non riesco a capire come documentare le eccezioni usando Sphinx. ho provato la seguente: def some_funct(): """ :raises: ExceptionType: Some multi-line exception description. """

7calore

1risposta

incluso il contenuto dinamico nella documentazione generata da python-sfinge

Sto usando la sfinge per generare documentazione per il mio progetto e sto costruendo la documentazione come parte del processo di installazione del prodotto. Mi piacerebbe includere dinamicamente il

19calore

2risposta

Come posso includere la homepage nel TOC Sphinx?

Diciamo che ho un progetto Sfinge con le seguenti fonti: index.rst installation.rst templating/ index.rst module.rst fieldtype.rst index.rst (homepage) ha la seguente albero TOC: ..

5calore

1risposta

L'uso di sé per creare una sitemap con toctree nella sfinge sembra rotto?

Sto aggiornando una FAQ per un progetto abbastanza grande e vorrei aggiungere un indice delle domande nella parte superiore della pagina, in modo che gli utenti possano trovare più facilmente ciò che

8calore

3risposta

Fare Sfinge produrre blocchi di codice untypogrified in output PDF

I blocchi di codice sembrano brutti (controllare le virgolette) in output PDF: Io uso la versione 1.1.3 della Sfinge, e ha usato il seguente comando per produrre il doc: $ make latexpdf Inoltre, la

7calore

2risposta

Sphinx's .. include :: direttiva e "etichetta duplicata" avvisi

Sto cercando di utilizzare Sphinx 's .. include:: directive per includere documenti da un file in un altro file, per evitare la duplicazione del testo di origine dei documenti. La sezione che sto tra

6calore

3risposta

python-sfinge: come visualizzare il codice di comando di Linux frammenti

Utilizzando sfinge, so che è possibile mostrare un pezzo di frammento di codice Python o codice Ruby frammento da avere qualcosa di simile: .. code-block:: ruby. ${your ruby code goes here} Com

6calore

2risposta

documentazione Sfinge e autodoc-saltare-membro

Sto costruendo il mio sfinge doc per un progetto Django seguente modo: sphinx-apidoc app -o docs/source/app --force Ora include tutte le migrazioni Sud, che non vogliono avere a la mia documentazion

7calore

3risposta

Come creare figure fluttuanti in reStructuredText/Sphinx?

Voglio avere una figura con il testo avvolto attorno ad essa. Questo è quello che sto dicendo: Installation of Optional Accessories ==================================== .. warning:: Never plug in o