为Python类生成文档

Tei*_*ion 11 python documentation data-structures

我即将开始一个项目,我将成为唯一一个做实际代码的人和两个经验不足的程序员(可怕的想象自己经验丰富!)将会一直在观看并对程序提出建议.

是否有一个好的(免费)系统,我可以根据我编写的代码提供类和函数的文档?它可能会帮助他们掌握数据结构.

Gre*_*ill 12

我使用epydoc从嵌入式文档字符串生成Python模块的文档.它非常易于使用,并以多种格式生成漂亮的输出.


Jim*_*imB 11

python.org现在使用sphinx作为它的文档.

我个人喜欢sphinx在epydoc上的输出.我还觉得重构文本在文档字符串中比epydoc标记更容易阅读.