Commenti di documentazione aggregati da più script in README?

0

Dopo aver scritto alcuni script Python con commenti per la documentazione all'interno, è una buona idea e possibile aggregare i commenti della documentazione da più script in qualche file di documentazione standalone come README?

Inoltre, è possibile aggregarli in alcuni formati di markup come Markdown?

Grazie.

    
posta Tim 19.03.2015 - 17:09
fonte

1 risposta

2

Consiglio vivamente di consultare Epydoc e anche Sphinx-Doc .

In particolare, Epydoc fa esattamente quello che stai chiedendo, come dichiarato sul loro sito web e secondo la mia esperienza con esso:

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings.

    
risposta data 19.03.2015 - 17:17
fonte

Leggi altre domande sui tag