pydoc用法简介

转发：https://www.jianshu.com/p/af8eabb43cb8

python中pydoc模块可以从python代码中获取docstring，然后生成帮助信息。

纯文本帮助

windows环境下，运行：

python -m pydoc atexit 

Linux环境下直接运行：

pydoc atexit

上面的命令会在控制台生成atexit的纯文本帮助信息。

HTML帮助

pydoc还可以生成HTML输出，既可以将HTML帮助信息输出到静态文本中，也可以启动一个Web服务器在线浏览帮助文档。

Windows环境下：

python-m pydoc-w atexit   //在当前目录创建

atexit.htmlpython-m pydoc-p5000  //启动一个Web服务器监听http://localhost:5000/

Linux环境下：

pydoc -w atexitpydoc -p 5000

交互式帮助

pydoc还未__builtins__添加了一个函数help()，从而可以在解释器窗口访问同样的信息。

>>>help(atexit)Helponmoduleatexit：NAMEatexit