python - 如何使用 Pydoc 创建文档？

Question

我正在尝试从我的模块中创建一个文档。我使用 Python 3.2.3 从 Windows 7 的命令行中使用了 pydoc:

python "<path_to_pydoc_>\pydoc.py" -w myModule

这导致我的 shell 被文本填充，我的模块中的每个文件一行，说:

no Python documentation found for '<file_name>'

好像 Pydoc 试图为我的文件获取文档，但我想自动创建它。我找不到使用 Google 的好教程。有人对如何使用 Pydoc 有任何提示吗？

如果我尝试使用

从一个文件创建文档

python ... -w myModule\myFile.py

上面写着wrote myFile.html，当我打开它时，有一行文字说:

# ../myModule/myFile.py

此外，它还有一个指向我计算机上文件本身的链接，我可以单击它，它会在我的网络浏览器上显示文件中的内容。

Answer 1

人们可能会觉得有用的另一件事...确保在您的模块名称中去掉“.py”。例如，如果您尝试在 'original.py' 中为 'original' 生成文档:

yourcode_dir$ pydoc -w original.py
no Python documentation found for 'original.py'

yourcode_dir$ pydoc -w original
wrote original.html