如何使用 Pydoc 创建文档？

Question

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

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

这导致我的 shell 充满了文本，我的模块中的每个文件一行，说：

 no Python documentation found for '<file_name>'

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

如果我尝试使用

python ... -w myModule\myFile.py

它说 wrote myFile.html ，当我打开它时，它有一行文字说：

 # ../myModule/myFile.py

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

原文由 user1632861 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

正如 RocketDonkey 所建议的，您的模块本身需要有一些文档字符串。

例如，在 myModule/__init__.py 中：

 """
The mod module
"""

您还希望为 myModule/*.py 使用

pydoc myModule.thefilename

确保生成的文件与主模块文档文件中引用的文件相匹配。

原文由 michel-slm 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

人们可能会发现有用的另一件事…确保从您的模块名称中删除“.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

原文由 K.S. 发布，翻译遵循 CC BY-SA 3.0 许可协议