使用Pydoc生成模块文档

合集 - Python项目文档(3)

1.使用Pydoc生成模块文档2023-07-06

2.使用Sphinx生成项目文档2023-07-063.使用Mkdocs生成项目文档2023-07-06

收起

Pydoc是Python内置的一个根据函数注释生成文档的工具，可以快速生成项目文档。

命令行显示文档#

使用python3 -m pydoc <模块或包名>可以在命令行模块或包中所有模块交文档。
例如：

$ python -m pydoc python_yapi

输出效果如下：

按q退出文档查看

生成html文档#

使用python3 -m pydoc -w <模块或包名>，可以生成模块或包的HTML文档。
例如：

$ python3 -m pydoc -w python_yapi
wrote python_yapi.html

浏览器打开生成的python_yapi.html文件，效果如下：

启动静态服务并在浏览器查看文档#

使用python3 -m pydoc -b，可以启动一个静态服务器，并自动打开浏览器，显示当前项目所有模块的文档，配合-p参数可以指定启动静态服务绑定的端口。
显示效果如下。

命令行中输入q回车，可以退出并关闭文档静态服务器。