[Python] Doxygen -- creare documentazione

[Alessandro Dentella]

On Wed, Jun 16, 2010 at 02:44:55PM +0200, Vittorio Zuccala' wrote:
> Caspita, questo si che   un bel consiglio!
> Lo faccio subito perch  cos  provo tutti e tre i sistemi.
> Quindi secondo te vale la pena investire del tempo per imparare sphinx...

Io appoggio in pieno l'uso di Sphinx anche se non ho esperienza in altri
sistemi. La caratteristica che ha già esposto Daniele sulla possibilità di
unire parti discorsive e parti di instrospezione è ottima.

Rest è sicuramemnte un sistema che dopo poco diventa completamente naturale
e non invasivo.

Le aggiunte a Rest di Sphinx ne fanno un sistema estremamente
versatile. Amo molto ad esempio i riferimenti incrociati che possono essere
messi nel codice e referenziali dalle parti dicorsive e viceversa nonchè i
messaggi in fase di compilazione della documentazione sul fatto che alcune
pagine possono essere state omesse dall'indice.

I siti che hanno documentazione in sphinx sono ormai moltissimi, se vuoi
vedere come si possono anche integrare immagini dai una occhiata a quello che
c'è in calce (sqlkit). Ovviamente poi per i css, l'unico limite è la tua
creatività... 


sandro
*:-)



-- 
Sandro Dentella  *:-)
http://sqlkit.argolinux.org        SQLkit home page - PyGTK/python/sqlalchemy