[Python] Documentare Python

Alessandro Dentella sandro a e-den.it
Gio 15 Ott 2009 19:26:14 CEST


On Wed, Oct 14, 2009 at 01:02:50PM +0200, Daniele Varrazzo wrote:
> Sfortunatamente il progetto non è più tanto attivo: mi sembra che ora il
> più attivo tra i progetti simili sia Sphinx (http://sphinx.pocoo.org/) che
> è il sistema con cui viene creata la documentazione ufficiale del Python.
> Non so che vantaggi abbia rispetto ad altri sistemi... ma se è riuscito a
> mandare in pensione il sistema di documentazione precedente basato su
> LaTeX, qualcosa di buono deve averlo! :)

non ho mai usato epidoc, quindi non faccio un confronto. I punti di forza di
sphinx per guadagnarsi me come appassioneto utente sono stati:

 * che è basato sul formato ReST che a me piace molto, trovo elegante,
   chiaro ed estremamente semplice

 * che permette con poco di ottenere una grafca accattivante

 * che aggiunge a ReSt alcune direttive che permettono di connettere pagine
   differenti con sintassi molto semplice

 * che permette di produrre documentazione pdf di ottima qualità usando
   LaTeX

Davvero scrivere documentazione è diventata una esperienza semplice e di
grande soddisfazione. 

sandro
*:-)


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


Maggiori informazioni sulla lista Python