[Python] [OT] Documentazione online

Infrid debate a infrid.com
Gio 14 Nov 2013 21:12:54 CET


Puoi usare sphinx-doc[1], lo stesso software in uso per la
documentazione di Python (e molti altri progetti). Lo uso sporadicamente
ma è davvero un gioiellino, per il versioning puoi affidarti a qualche
software come mercurial o git.

Scrivi la documentazione su file di testo usando il formato rst[2], poi
lanci il comando per la generazione della documentazione in formato
html, epub, tex, pdf...

Modificando il template, che richiede davvero pochi sforzi, puoi mettere
un link alle varie versioni della documentazione (precedentemente
generate in html).

Saluti
Infrid

[1] http://sphinx-doc.org/
[2] http://docutils.sourceforge.net/rst.html


Maggiori informazioni sulla lista Python