On Wed, Oct 14, 2009 at 12:38:22PM +0200, Antonello Mangone wrote: > Ciao a tutti, posto una richiesta che spero non sia considerata troppo > particolare. > Non so se fattibile, ma vorrei documentare Python in modo da produrre dei > documenti HTML in stile API di Java, PHP ecc ... o altrimenti in altri > formati, > ma comunque qualcosa di statico che pu essere ovviamente aggiornato in > maniera > rapida, partendo dai commenti che vengono inseriti all'interno delle classi > Python e delle funzioni o metodi. > I commenti di cui parlo sono quelli che iniziano e finiscono con """ e """, > che > vengono utilizzati da IDE evoluti per fornire documentazione di classi e > funzioni durante il loro uso. > Un grosso grazie a chiunque riesca a fornirmi una dritta ... anche solo > documentazione
Ti suggerisco di guardare sphinx, il sistema concui viene prodotta la documentazione di python stesso su www.python.oro, di django e di tanti altri (fra cui [1] :-). Oltre a permettere di scrivere la documentazione in formato rst aggiunge molte direttive molto comode oltre a cose come 'automodule' che legge la docstring del modulo, 'autoclass' che legge la docstring della classe e a piacimento produce la documentazione per i vari metodi: http://sphinx.pocoo.org/ sandro *:-) -- Sandro Dentella *:-) [1] http://sqlkit.argolinux.org SQLkit home page - PyGTK/python/sqlalchemy _______________________________________________ Python mailing list Python@lists.python.it http://lists.python.it/mailman/listinfo/python
