python文档的好站点rubydoc.org网站

Question

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

• http://ruby-doc.org/docs/ProgrammingRuby/
• http://api.rubyonrails.org/（我知道，这是rails，不仅仅是 红宝石）
• http://apidock.com/ruby/

我当然知道官方文件：http://docs.python.org。我正在寻找一些更强大的功能，如搜索自动完成，评论等。就个人而言，我觉得官方文件有点僵硬导航和阅读。在

如果没有这样的替代网站存在，你会建议我如何着手创建一个？有什么API可以查询python文档吗？在

注意这个问题是相关的：What is good online documentation

Answer 1

多年来，我一直使用thomasheller的online help system作为快速访问Python库参考、语言参考和Python/capi手册中的资料的方法。在

因为它是基于CGI的，在Windows上，你可以使用类似于AutoHotKey的东西来制作一个键盘宏，在你喜欢的pythonide或纯文本编辑器中选择一些文本后访问它。在

Answer 2

这不是另一个网站，而是访问文档的另一种方式（如果你慷慨大方，甚至可以作为文档的api）。您只需要一个python解释器：

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

我发现这是一个很好的方法，可以快速检查如何拼写一个方法，或者参数的顺序，而不必打开web浏览器。在

或者，正如Steven Rumbalski所指出的，还有builtin function ^{}。这可以交互式地用于显示有关给定模块的更多信息。而且，正如rplnt所指出的，许多shell在访问python的帮助/自我文档功能时都有一些语法上的甜点。在

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

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