python文档的好站点，如ruby-doc.org [关闭]答案

【问题标题】：Good site for python documentation like ruby-doc.org [closed]python文档的好站点，如ruby-doc.org [关闭]
【发布时间】：2011-10-31 14:42:17
【问题描述】：

我喜欢 python，但我对它提供的在线文档感到失望。 Ruby 似乎有更多的文档站点：

我当然知道官方文档：http://docs.python.org。我正在寻找更强大的东西，具有搜索自动完成、评论等功能。就我个人而言，我发现官方文档有点难以浏览和阅读。

如果不存在这样的替代网站，您会建议我如何创建一个？是否有某种 API 可以查询 python 文档？

【问题讨论】：

我从来没有遇到过简单地使用谷歌搜索python文档的问题。此外，我相信在 python 的禅宗中，有一个正确的方法来完成一项任务（例如文档）：“应该有一种——最好只有一种——明显的方式来完成它。”
不管怎样，这个 Python 程序员经常对 ruby 文档感到沮丧。我真的很喜欢 Python 文档，因为它们可以作为指南，而不仅仅是方法列表。也许当你成长为一种语言时，你的大脑会适应它的文档实践。

【解决方案1】：

这不是另一个网站，而是一种访问文档的不同方式（如果您大方的话，甚至可能有资格成为文档的 api）。你只需要一个 python 解释器：

import csv
print csv.__doc__
dir(csv)
print csv.reader.__doc__

我发现这是一种快速检查方法的拼写方式或参数顺序的好方法，无需打开网络浏览器。

或者，正如 Steven Rumbalski 所指出的，还有builtin function help。这可以交互地用于显示有关给定模块的更多信息。此外，正如 rplnt 所指出的，许多 shell 都有一些语法糖来访问 python 的帮助/自我文档功能。

但是，如果您真的想以编程方式创建自己的文档网站/系统，那么一个不错的开始可能是使用 dir 内置函数来爬取给定模块的对象层次结构，并编译 docstrings 的所有不同的方法/功能（这是__doc__ 正在访问的内容）。

不过，我个人认为，在大多数情况下，将交互式帮助和在 google 中使用 site:docs.python.org 相结合就足够了。

【讨论】：

在ipython（也可能在其他python shell中）你可以输入模块、类、函数等的名称，然后在它后面加上?，按回车并获取信息（包括文档字符串）。在模块上使用 dir 也不是必需的，因为您有选项卡完成。
更好的方法是help(csv)。它将为您提供与 print csv.__doc__ 相同的简介，以及模块中定义的所有类、函数和数据。
这些都是好点。我已经编辑了我的回复以包括它们。不过，我很确定 dir 和 __doc__ 的组合是以编程方式访问这些东西的最佳方式（如果操作人员实际上有兴趣尝试这样做），我最初可能并不清楚。跨度>
Ipython 还包括当前命名空间中的制表符补全。因此，您可以键入 csv.，然后弹出窗口将列出 csv 模块中的所有内容。

【解决方案2】：

多年来，我一直使用 Thomas Heller 的 online help system 作为访问 Python 库参考、语言参考和 Python/C API 手册中材料的快捷方式。

由于它是基于 CGI 的，因此在 Windows 上，可以使用 AutoHotKey 之类的东西来制作键盘宏，以便在从您最喜欢的 Python IDE 或纯文本编辑器中选择一些文本后访问它。

【讨论】：