python-sphinx

7calore

1risposta

Come faccio a evitare che Sphinx ignori l'avviso GPL nella mia docstring?

Sto usando Sphinx per documentare il mio pacchetto Python. Quando uso la direttiva automodule sul mio modulo: .. automodule:: mymodule :members: viene stampato tutto, compreso il bando GPL nella do

python python-sphinx docstring 2013-06-20

---

5calore

3risposta

Come evitare gli avvisi di "SEVERE: Duplicate ID" per i miei moduli autodoc'd in Sfinge?

Sto usando RST/Sfinge per documentare il mio Python, tuttavia quando la costruzione è lanciando avvertimenti come ...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast". file sorgenti mio Pyth

python documentation python-sphinx 2013-05-09

---

7calore

1risposta

Fai autodoc mostrano i valori di default della Sfinge nei parametri Descrizione

Ho il seguente docstring: def progress_bar(progress, length=20): ''' Returns a textual progress bar. >>> progress_bar(0.6) '[##########--------]' :param progress: Number bet

python python-sphinx autodoc 2013-06-29

---

8calore

1risposta

Come posso generare documentazione per un setter di proprietà Python usando Sphinx?

Ho una classe Python qualcosa di simile a quanto segue, con docstring destinati ad essere convertiti in documenti da Sphinx: class Direction(object): """ A direction in which movement can be

python properties python-sphinx 2013-07-04

---

7calore

1risposta

compilazione di sphinx separata e directory di origine per il controllo della versione

Ho una directory di lavoro che contiene il mio progetto e si trova in un sistema di controllo della versione. Mi piacerebbe creare una directory doc all'interno del mio progetto che contenga solo file

python-sphinx 2013-05-17

---

5calore

1risposta

Come cercare i caratteri cinesi e le parole brevi nella documentazione generata da Sphinx?

apt-get install python-sphinx apt-get install sphinxsearch mkdir rest cd rest/ sphinx-quickstart Creo il mio primo articolo nel testo ristrutturato. http://s.yunio.com/!LrAsu si prega di sc

python python-sphinx restructuredtext 2013-05-25

---

8calore

2risposta

Sfinge: modo corretto per documentare un enum?

Guardando attraverso lo C and C++ domains di Sphinx, non sembra avere supporto nativo per documentare enumerazioni (e molto meno enumerazioni anonime). A partire da ora, uso cpp:type:: per il tipo enu

c++ python-sphinx restructuredtext 2013-07-17

---

7calore

1risposta

Sfinge: le classi appaiono sul TOC

Sto iniziando a documentare alcune classi python usando ext.autodoc. Ho diversi file * .rst con contenuti quali ======== mymodule ======== .. automodule:: mymodule .. autoclass:: myclassA

python-sphinx 2013-07-21

---

7calore

2risposta

Crea un file PDF di documentazione Python

Il sito ufficiale Python offre download di documentazione PDF, ma sono separati da capitoli. Ho scaricato il codice sorgente e creato la documentazione PDF, che era anche un PDF separato. Come è possi

python documentation python-sphinx 2013-07-22

---

8calore

1risposta

toctree Sfinge visualizza un sommario nella barra laterale con un elenco puntato nel corpo o nulla del tutto

Sto lavorando con Sfinge (sphinx-1.2b1-py2.7). Voglio che un sommario appaia in una barra laterale. Sembra binario: posso solo ottenere sia un TOC nella barra laterale e un elenco puntato nel corpo de

python-sphinx 2013-06-19

---