是我一个人,还是python标准库文档极难浏览?
Java 有其出色的Javadocs,Ruby 有其有用的 Ruby-Docs,只有在 python 中我找不到浏览标准库文档的好方法。
有一个Epydoc项目,看起来不错,但有谁知道它是否真的在标准库中使用,所以我们都可以通过它吗?如果没有,人们用来浏览 python 文档的替代方法是什么。
是我一个人,还是python标准库文档极难浏览?
Java 有其出色的Javadocs,Ruby 有其有用的 Ruby-Docs,只有在 python 中我找不到浏览标准库文档的好方法。
有一个Epydoc项目,看起来不错,但有谁知道它是否真的在标准库中使用,所以我们都可以通过它吗?如果没有,人们用来浏览 python 文档的替代方法是什么。
我通常使用内置的pydoc,如果你在 windows 上,如果你在 linux 上使用pydoc -p 8000
并通过浏览器连接,它应该被称为 Module Docs。
pydoc
从命令行,help()
从交互式解释器提示。
pydoc -p 8080
python 社区对自动生成的文档持半敌意态度,特别是如果它是面向对象的。Python 不仅仅是面向对象的(它是一种多范式语言),因此 Python 开发人员通常更喜欢人工编写的文档。有时功能很重要,有时类结构很重要。
你可以去这里下载Python 3.1的chm版本。有了这个,搜索文档应该很容易。
很久以前,我曾经使用 Edgewall 的python 侧边栏。
这些天,我在谷歌搜索python函数(标准文档几乎总是显示为第一个链接)。如果我想浏览模块的源代码(有时很有用),我使用我写的这个小shell函数。
epy () {
cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__"
file=$(/usr/bin/env python -c $cmd)
echo $file
emacsclient --no-wait $file
}
我想我会被否决,但我发现 Sphinx 文档没有任何问题,而且我发现它们比 java 替代品要好得多。