如何使用Pydoc创build文档？
我试图从我的模块创build一个文档。 我使用Python 3.2.3的Windows 7中的命令行使用了pydoc ：
python "<path_to_pydoc_>\pydoc.py" -w myModule
这导致我的shell被填充文本，在我的模块中的每个文件一行，说：
no Python documentation found for '<file_name>'
就好像Pydoc试图为我的文件获取文档，但我想自动创build它。 我找不到使用Google的好教程。 有没有人有关于如何使用Pydoc的任何提示？
如果我尝试使用一个文件创build文档
python ... -w myModule\myFile.py, it says "wrote myFile.html", and when I open it, it has one line of text saying: # ../myModule/myFile.py
此外，它还有一个链接到我的电脑上的文件本身，我可以点击它，并显示在我的网页浏览器中的文件内。
正如RocketDonkey所build议的，你的模块本身需要有一些文档。
例如，在myModule/__init__.py ：
""" The mod module """
你也想为myModule/*.py每个文件生成文档
pydoc myModule.thefilename
以确保生成的文件与主模块文档文件中引用的文件相匹配。
另一个人可能会觉得有用的东西…确保离开你的模块名称“.py”。 例如，如果您正尝试在“original.py”中为“原始”生成文档：
yourcode_dir$ pydoc -w original.py no Python documentation found for 'original.py' yourcode_dir$ pydoc -w original wrote original.html
pydoc对于生成文档非常棒，但是文档必须首先写入。 您必须在源代码中包含文档，正如RocketDonkey在注释中提到的那样：
""" This example module shows various types of documentation available for use with pydoc. To generate HTML documentation for this module issue the command: pydoc -w foo """ class Foo(object): """ Foo encapsulates a name and an age. """ def __init__(self, name, age): """ Construct a new 'Foo' object. :param name: The name of foo :param age: The ageof foo :return: returns nothing """ self.name = name self.age = age def bar(baz): """ Prints baz to the display. """ print baz if __name__ == '__main__': f = Foo('John Doe', 42) bar("hello world")
第一个文档string提供了使用pydoc创build文档的说明。 有不同types的docstrings的例子，所以你可以看到他们看起来如何使用pydoc生成。
使用pydoc.doc（）可以显示文档string，可以是类，模块等
