我正在尝试从我的模块中创建一个文档。我pydoc
在Windows 7中使用Python 3.2.3从命令行使用:
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
另外,它具有指向我计算机上文件本身的链接,单击该链接即可显示它在Web浏览器中的内容。
正如RocketDonkey所建议的那样,您的模块本身需要一些文档字符串。
例如,在myModule/__init__.py
:
"""
The mod module
"""
您还希望为myModule/*.py
使用中的每个文件生成文档
pydoc myModule.thefilename
确保生成的文件与主模块文档文件中引用的文件匹配。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句