类似于ruby-doc.org的优秀Python文档网站

0 投票
2 回答
1270 浏览
提问于 2025-04-17 05:20

我很喜欢Python,但对它的在线文档有点失望。相比之下,Ruby似乎有很多更多的文档网站:

当然,我知道有官方文档:http://docs.python.org。不过,我希望能找到更强大的文档网站,像是有搜索自动补全、评论等功能。就我个人而言,我觉得官方文档在浏览和阅读时有点僵硬。

如果没有这样的替代网站,你会建议我怎么去创建一个?有没有什么API可以查询Python的文档?

注意,这个问题是相关的:什么是好的在线文档

2 个回答

0

我多年来一直在使用Thomas Heller的在线帮助系统,这是一个快速访问Python库参考、语言参考和Python/C API手册的好方法。

因为这个系统是基于CGI的,所以在Windows上,你可以使用类似AutoHotKey的工具,创建一个键盘宏,这样在你从喜欢的Python开发环境或文本编辑器中选择一些文本后,就可以快速访问这个帮助系统。

2

这不是另一个网站,而是一种不同的方式来访问文档(如果你愿意,可以把它看作是文档的一个API)。你只需要一个Python解释器:

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

我发现这是一种很好的方法,可以快速检查一个方法的拼写,或者参数的顺序,而不需要打开网页浏览器。

另外,正如Steven Rumbalski指出的,还有一个内置函数help。这个函数可以交互式地显示关于某个模块的更多信息。此外,rplnt也提到,很多命令行工具都有一些简便的方式来访问Python的帮助或自我文档功能。

不过,如果你真的想要程序化地创建自己的文档网站或系统,一个不错的开始是使用内置的dir函数,遍历某个模块的对象层次结构,并收集所有不同方法/函数的文档字符串(这就是__doc__所访问的内容)。

不过我个人认为,结合使用交互式帮助和在谷歌中搜索site:docs.python.org,在大多数情况下已经足够了。

撰写回答