如何使用Pydoc生成文档
我想通过注释生成文档，使用的是pydoc。请问我该怎么做，基本步骤是什么？
2 个回答
2
另外，如果你想要一个简单的文本文件，而不是HTML格式的文件，你可以用这个简单的命令把控制台的输出内容保存到一个文件里：
$ pydoc myproject > helpfile.txt
这个文件可以很方便地打印出来或者上传到Github，操作起来也不麻烦。
11
如果你真的想用Pydoc，可以在终端里简单地输入：
$ pydoc -w myproject
这样就能从文档字符串生成一个老派的HTML文档。需要注意的是，Pydoc是Python从2.1版本开始用来实现help()功能的模块。它会提取文档字符串，而不是注释。你应该用文档字符串来描述你的函数。
不过，用Pydoc生成文档有点过时了。在Python中，比较流行的工具是Sphinx。不过你需要把文档字符串格式化成特定的格式，叫做reStructuredText。
你也可以使用pdoc，它可以自动从你的文档字符串中提取文档（也就是公共API），并支持markdown、numpydoc、google风格的文档字符串格式和一些reStructuredText指令。
你可以在这里查看一些关于文档字符串格式化的信息。
另外，你还可以使用Pyment来生成文档字符串的框架，或者把已有的文档字符串转换成特定的格式。