Quindi il vecchio sistema di documentazione basato su LaTeX è ufficialmente in disuso e Sphinx assume il ruolo di tool ufficiale ?<br><br><div class="gmail_quote">Il giorno 14 ottobre 2009 13.02, Daniele Varrazzo <span dir="ltr"><<a href="mailto:piro@develer.com">piro@develer.com</a>></span> ha scritto:<br>
<blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><div><div></div><div class="h5">On Wed, 14 Oct 2009 12:38:22 +0200, Antonello Mangone<br>
<<a href="mailto:antonello.mangone@gmail.com">antonello.mangone@gmail.com</a>> wrote:<br>
> Ciao a tutti, posto una richiesta che spero non sia considerata troppo<br>
> particolare.<br>
> Non so se è fattibile, ma vorrei documentare Python in modo da produrre<br>
dei<br>
> documenti HTML in stile API di Java, PHP ecc ... o altrimenti in altri<br>
> formati, ma comunque qualcosa di statico che può essere ovviamente<br>
> aggiornato in maniera rapida, partendo dai commenti che vengono inseriti<br>
> all'interno delle classi Python e delle funzioni o metodi.<br>
> I commenti di cui parlo sono quelli che iniziano e finiscono con """ e<br>
""",<br>
> che vengono utilizzati da IDE evoluti per fornire documentazione di<br>
classi<br>
> e<br>
> funzioni durante il loro uso.<br>
> Un grosso grazie a chiunque riesca a fornirmi una dritta ... anche solo<br>
> documentazione<br>
<br>
</div></div>Io ho partecipato a Epydoc (<a href="http://epydoc.sourceforge.net/" target="_blank">http://epydoc.sourceforge.net/</a>), che forse è<br>
stato il più completo progetto per generare le API dal codice Python.<br>
Effettua sia introspezione che parsing del codice Python (in modo da<br>
ottenere materiale sia da docstring che da commenti) e dà la possibilità di<br>
linkare i commenti al codice, produrre grafi di dipendenza o uml e tanto<br>
altro.<br>
<br>
Sfortunatamente il progetto non è più tanto attivo: mi sembra che ora il<br>
più attivo tra i progetti simili sia Sphinx (<a href="http://sphinx.pocoo.org/" target="_blank">http://sphinx.pocoo.org/</a>) che<br>
è il sistema con cui viene creata la documentazione ufficiale del Python.<br>
Non so che vantaggi abbia rispetto ad altri sistemi... ma se è riuscito a<br>
mandare in pensione il sistema di documentazione precedente basato su<br>
LaTeX, qualcosa di buono deve averlo! :)<br>
<br>
Altra documentazione API notevole fatta con Sphinx è quella di Matplotlib<br>
(es. vedi <a href="http://matplotlib.sourceforge.net/api/artist_api.html" target="_blank">http://matplotlib.sourceforge.net/api/artist_api.html</a>).<br>
<br>
Insomma, anche se sono affezionato a Epydoc<br>
(<a href="http://epydoc.sourceforge.net/api/epydoc.apidoc.ValueDoc-class.html" target="_blank">http://epydoc.sourceforge.net/api/epydoc.apidoc.ValueDoc-class.html</a> non è<br>
male, no?) ho paura che il futuro non passi di lì :\<br>
<font color="#888888"><br>
--<br>
Daniele Varrazzo - Develer S.r.l.<br>
<a href="http://www.develer.com" target="_blank">http://www.develer.com</a><br>
</font><div><div></div><div class="h5">_______________________________________________<br>
Python mailing list<br>
<a href="mailto:Python@lists.python.it">Python@lists.python.it</a><br>
<a href="http://lists.python.it/mailman/listinfo/python" target="_blank">http://lists.python.it/mailman/listinfo/python</a><br>
</div></div></blockquote></div><br>