python文档生成工具pydoc

为了找到对象及其文档内容，pydoc 会导入文档所在的模块。 因此，任何模块层级的代码都将被执行。 请使用 if name == ‘main’: 语句来确保一个文件的特定代码仅在作为脚本被发起调用时执行而不是在被导入时执行。

pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的，也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！

和 help() 及 doc 不同，使用 pydoc 模块无需编写任何 python 代码，通过执行 python 命令即可查看程序中成员的说明性文档。

python -m pydoc 模块名
其中，-m 表示运行指定模块，这里表示要执行 pydoc 模块。注意在指定模块名时，除非其创建在 Python 解释器能自行找到的目录下，否则这里要明确模块所在的位置。

python -m pydoc demo
执行此命令，即可看到 demo.py 文件中 display() 函数、my_cla 类以及该类中 say() 实例方法的说明性文档。

pydoc 还可以将指定模块的帮助信息提取出来，并自动组织成一个 HTML 文档。

python -m pydoc -w 模块名
上面命令主要就是为 pydoc 模块额外指定了 -w 选项，该选项代表 write，表明输出 HTML 文档。

例如，在 demo.py 所在当前目录下运行如下命令：

python -m pydoc -w demo
运行上面命令，可以看到系统生成“wrote demo.html” 提示信息。接下来可以在该目录下发现额外生成了一个 demo.html