python入坑之路（三 pydoc和help帮助手册）

在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc.
pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！
https://docs.python.org/3.6/library/pydoc.html

一、-k查找模块

python通过-k查找模块，会在当前工程目录以及python环境变量目录下查找包含关键词的模块信息
pydoc3 -k 关键词，如 pydoc3 -k pydoc3 -k os

二、查看模块帮助

pydoc3 modulename

三、启动本地服务，在web上查看文档

pydoc3 -p 12345

说明：

1、-p指定启动的服务的端口号，可以随意指定不冲突的端口号

2、只有在自建的工程根目录下使用该命令，才能看到当前工程下所有的内容，否则只能看到python环境变量下的模块内容

转载于:https://www.cnblogs.com/snowinglx/p/8306404.html