如果你真的想使用Pydoc,你可以简单地在终端中做:
$ pydoc -w myproject
这将生成一个来自doctrings的旧式HTML文档.请注意,Pydoc是自2.1以来Python中使用的模块help().它将检索不是注释的文档字符串.您应该使用docstrings描述您的函数.
但它是一种使用Pydoc进行文档生成的老派.在Python中使用的流行工具是Sphinx.但是您需要将特定格式的文档字符串格式化为reStructuredText.
您还可以使用pdoc,它自动从文档字符串中提取文档(即公共API),并支持markdown,numpydoc,google-style docstrings格式和一些reStructuredText指令.
看看这里获取有关docstrings格式的一些信息.
您还可以使用Pyment生成docstring骨架或将现有骨架转换为特定格式.
| 归档时间： |
|
| 查看次数： |
6971 次 |
| 最近记录： |