浏览python api的替代方法[关闭]答案

【问题标题】：Alternative ways to browse the python api [closed]浏览python api的替代方法[关闭]
【发布时间】：2010-01-25 09:57:48
【问题描述】：

是我一个人，还是python标准库文档极难浏览？

Java 有其出色的Javadocs，Ruby 有其有用的Ruby-Docs，只有在 python 中我找不到浏览标准库文档的好方法。

有Epydoc 项目，看起来不错，但有谁知道它是否真的在标准库中使用，所以我们都可以通过它吗？如果没有，人们用来浏览 python 文档的替代方法是什么。

【问题讨论】：

Python 和许多大型库都使用 Sphinx 作为文档。从可用性的角度来看，生成的文档非常糟糕（即使它们使用了一些好看的 CSS）。一个例子就是页面非常长，这使得浏览变得非常困难。
哇... Python 可能不是最出色的文档，但将它与 javadoc 相比是不是很不利？文档几乎是我对 Java 最不喜欢的东西：你通常会得到一个小的表面教程，然后就只有 javadoc：一个无用的类和方法技术细节迷宫，没有找到如何安排所有内容以及你做什么的指导。预计会使用。
我发现 javadocs 是浏览 API 的绝佳工具。文档本身的质量不是工具的责任，而是文档作者的责任。所以恕我直言，是的，javadocs 比官方 python 文档站点使用的要好得多。
-1：Javadocs 很棒？对不起，看不出你如何证明这一点。您是否有任何具体问题可以添加到问题中？有什么证据吗？ Python 文档中缺少的 javadocs 的任何具体、具体的特性？
来自库生产者 p.o.v.，编写 javadocs 可能很烦人，主要是由于 HTML 的冗长。从图书馆消费者 p.o.v. 来看，javadocs 非常简单直观，可以在几秒钟内找到有关任何给定类或方法的信息。 'Brilliant' 可能是一个过于强烈的词，但是是的，作为一个 API 用户，我觉得它们很棒。你要证据吗？这是什么，一场宗教辩论？只需浏览在线 jdk javadocs 和在线 python 模块索引并比较...

标签： python documentation standard-library

【解决方案1】：

我通常使用内置的pydoc，如果你在windows上它应该被称为Module Docs，如果你在linux上使用pydoc -p 8000并通过浏览器连接。

【讨论】：

【解决方案2】：

pydoc 来自命令行，help() 来自交互式解释器提示符。

【讨论】：

【解决方案3】：

pydoc -p 8080

python 社区对自动生成的文档持半敌意态度，尤其是在它是面向对象的情况下。 Python 不仅仅是面向对象的（它是一种多范式语言），因此 Python 开发人员通常更喜欢人工编写的文档。有时功能很重要，有时类结构很重要。

【讨论】：

是啊，我尝到了一些敌意……

【解决方案4】：

你可以去here下载Python 3.1的chm版本。有了这个，搜索文档应该很容易。

【讨论】：

【解决方案5】：

很久以前，我曾经使用 Edgewall 的 python sidebar。

这些天，我在谷歌上搜索 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
}

【讨论】：

【解决方案6】：

我想我会被否决，但我发现 Sphinx 文档没有任何问题，而且我发现它们比 java 替代品要好得多。

【讨论】：

我同意。 Sphinx 是一个很好的工具，它可以生成很好的文档。至少对于 Python :)