2010-01-25 12 views
15

Ist es nur ich, oder die Python-Standardbibliothek Dokumentation ist extrem schwierig zu durchsuchen?Alternative Möglichkeiten zum Durchsuchen der Python api

Java hat seine brillante Javadocs, Ruby hat seine hilfreich Ruby-Docs, nur in Python kann ich nicht einen guten Weg finden, über die Standard-Bibliothek Dokumentation zu navigieren.

Es gibt das Projekt Epydoc, das nett aussieht, aber weiß jemand, ob es tatsächlich auf der Standardbibliothek verwendet wird, so dass wir alle durchgehen können? Falls nicht, welche Alternativen werden von Benutzern zum Durchsuchen der Python-Dokumentation verwendet?

+5

Python und viele der großen Bibliotheken verwenden Sphinx für die Dokumentation. Aus Usability-Sicht sind die generierten Dokumente ziemlich schrecklich (obwohl sie ein paar gut aussehende CSS verwenden). Ein Beispiel dafür sind die extrem langen Seiten, die das Browsen sehr erschweren. – nikow

+3

Wow ... Python ist vielleicht nicht die wundervollste Dokumentation, aber vergleicht sie ungünstig mit * javadoc *? Das Dokument ist bei Java am wenigsten mein Favorit: Du bekommst normalerweise ein kleines oberflächliches Tutorial und dann gibt es nur noch das Javadoc: ein nutzloses Labyrinth aus technischen Details zu Klassen und Methoden ohne Anweisungen, wie alles arrangiert wird und was du ' re erwartet zu verwenden. – bobince

+7

Ich finde die Javadocs ein großartiges Werkzeug zum Durchsuchen von APIs. Die Qualität der Dokumentation selbst ist nicht Aufgabe des Tools, sondern des Dokumentationsautors. Also IMHO, ja, Javadocs sind viel besser als das, was die offizielle Python-Dokumentationsseite verwendet. – ivo

Antwort

8

Normalerweise verwende ich die integrierte pydoc, wenn Sie unter Windows sind, sollte es Module Docs aufgerufen werden, wenn Sie unter Linux pydoc -p 8000 verwenden und über den Browser verbinden.

2

können Sie gehen zu here und laden Sie die CHM-Version von Python 3.1. Die Suche in den Dokumenten sollte daher einfach sein.

3

pydoc von der Befehlszeile, help() von der interaktiven Interpreter-Eingabeaufforderung.

3

pydoc -p 8080

Die Python-Community ist semi-feindliche Dokumentation automatisch erzeugt, vor allem, wenn es Objektorientiert. Python ist nicht nur objektorientiert (es ist eine Sprache mit mehreren Paradigmen), so dass Python-Entwickler im Allgemeinen eine von Menschen geschriebene Dokumentation bevorzugen. Manchmal sind die Funktionen wichtig, manchmal ist die Klassenstruktur wichtig.

+0

Ja, ich habe etwas von der Feindseligkeit geschmeckt ... – ivo

0

Früher habe ich die python sidebar von Edgewall verwendet.

In diesen Tagen google ich für die Python-Funktion (die Standard-Dokumentation fast immer als erster Link angezeigt). Wenn ich die Quelle des Moduls (nützlich manchmal) durchsuchen möchte, verwende ich diese kleine Shell-Funktion, die ich schrieb .

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 
} 
0

Ich glaube, ich werde downvoted zu bekommen, aber ich finde nichts falsch mit der Sphinx-Dokumentation und ich finde sie Art und Weise Art und Weise besser als die Java-Alternative.

+0

Ich stimme zu. Sphinx ist ein gutes Werkzeug und es erzeugt gute Dokumente. Zumindest für Python :) –

Verwandte Themen