from: https://www.cnblogs.com/snowinglx/p/8306404.html
在Python中有很多很好的工具來生成字符串文檔(docstring),比如說: epydoc、doxygen、sphinx,但始終覺得pydoc還是不錯的工具,用法非常簡單,功能也算不錯,本文主要介紹pydoc.
pydoc是Python自帶的模塊,主要用於從python模塊中自動生成文檔,這些文檔可以基於文本呈現的、也可以生成WEB 頁面的,還可以在服務器上以瀏覽器的方式呈現!
https://docs.python.org/3.6/library/pydoc.html
一、-k查找模塊
python通過-k查找模塊,會在當前工程目錄以及python環境變量目錄下查找包含關鍵詞的模塊信息
pydoc -k 關鍵詞,如 pydoc -k pydoc3 -k os
二、查看模塊幫助
pydoc modulename
三、啓動本地服務,在web上查看文檔
pydoc -p 54321
說明:
1、-p指定啓動的服務的端口號,可以隨意指定不衝突的端口號
2、只有在自建的工程根目錄下使用該命令,才能看到當前工程下所有的內容,否則只能看到python環境變量下的模塊內容