可供選擇的方法來瀏覽python api

它只是我，還是python標準庫文檔非常難以瀏覽？可供選擇的方法來瀏覽python api

Java有其輝煌的Javadocs，Ruby有樂於助人的Ruby-Docs，只有在python我無法找到通過標準的庫文件進行導航的好辦法。

有Epydoc項目，看起來不錯，但有人知道它是否實際上在標準庫中使用，所以我們都可以通過它？如果沒有，人們用來瀏覽python文檔的選擇是什麼。

2010-01-25 ivo

Python和許多大型圖書館都使用Sphinx進行文檔編制。從可用性的角度來看，生成的文檔非常可怕（即使它們使用了一些漂亮的CSS）。其中一個例子是非常長的頁面，這使得瀏覽非常困難。 – nikow 2010-01-25 10:32:06

哇... Python可能不是最棒的文檔，但是將它與* javadoc *進行比較是不利的？這個文檔是我最不喜歡Java的東西：你通常會得到一個小的表面教程，然後只有javadoc：一個無用的迷宮類和方法的技術細節，沒有指示如何排列所有東西，重新有望使用。 – bobince 2010-01-25 10:53:30

我發現javadocs是瀏覽API的一個很好的工具。文檔本身的質量不是工具的責任，而是文檔作者的責任。所以恕我直言，是的，javadocs比官方的python文檔站點使用的要好得多。 – ivo 2010-01-25 12:29:06

我通常使用內置的pydoc，如果你在windows上，它應該被稱爲Module Docs，如果你在linux上使用pydoc -p 8000並通過瀏覽器連接。

來源

2010-01-25 10:30:29

你可以去here並下載chm版本的Python 3.1。因此，通過文檔搜索應該很容易。

來源

2010-01-25 10:02:04 ghostdog74

pydoc來自命令行，help()來自交互式解釋器提示。

來源

2010-01-25 10:32:36

pydoc -p 8080

Python社區是自動生成的半敵對的文件，尤其是如果它的目標爲導向。 Python不僅僅是面向對象的（這是一種多範式語言），所以Python開發人員通常更喜歡人爲編寫的文檔。有時候這些功能很重要，有時班級結構很重要。

來源

2010-01-25 10:42:35 wisty

是的，我嚐到了一些敵意...... – ivo 2010-01-26 10:58:00

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

這幾天，我對於python函數（標準docs幾乎總是顯示爲第一個鏈接）的谷歌。如果我想瀏覽模塊的源代碼（有時候有用），我使用這個我寫的小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 
}

來源

2010-01-25 10:45:31

我想我會得到downvoted，但我覺得沒有錯的獅身人面像文檔，我發現他們的方式方法比Java的替代更好。

來源

2010-01-30 09:14:42

我同意。獅身人面像是一個很好的工具，它可以生成很好的文檔。至少對於Python而言:) – 2012-07-27 03:53:07

可供選擇的方法來瀏覽python api

回答

相關問題