使用 pydoc 自动生成 Python 文档

Python 与 pydoc 一起提供。您可以使用pydoc为您的模块或包自动生成文档。为此,您的模块或包需要包含文档字符串。

您可以直接从终端执行pydoc 。cd 到包含要为其自动生成文档的模块的目录。然后,执行以下命令。

python -m pydoc -w modulename

在这种情况下,模块是 modulename.py。上面的命令将生成一个包含自动生成文档的 .html 文件。

对于较大的项目,我更喜欢将所有模块的所有文档存储在一个目录中。为此,我首先为每个模块创建文档。我用上面的命令这样做。

接下来,我使用以下命令创建一个空目录

mkdir docs

在这种情况下,新目录称为“docs”。

最后,我将所有自动生成的 .html 文件移动到docs目录中。

mv *.html docs