it-swarm.com.de

Wie exportiere ich alle Python -Dokumente eines Pakets und bringe es in Devhelp?

Um die Dokumentation eines Pakets zu lesen, zum Beispiel quickly, mache ich Folgendes:

>>> import quickly
>>> help(quickly)
 
>>> import quickly.widgets
>>> help(quickly.widgets)
 
>>> import quickly.widgets.text_editor
>>> help(quickly.widgets.text_editor)
 

und so weiter...

Das ist offensichtlich sehr langweilig. Wie kann ich die gesamte Schnelldokumentation einschließlich aller Unterpakete exportieren und sie dann im Dokumentationsbrowser devhelp anzeigen lassen?

Das Exportieren der Dokumentation als HTML wäre auch schön. Ich würde mich sogar freuen, wenn eine Version davon im Web existieren würde, aber ich kann anscheinend keine finden.

Hinweis: Mit Paket meine ich ein alt textpython-package , kein .deb-Paket.

6
Stefano Palazzo

Sie können eine HTML-Dokumentation eines python Moduls mit epydocerstellen.Install epydoc .

Epydoc ist ein Tool zum Generieren von API-Dokumentation für Python Module, basierend auf ihren Dokumentzeichenfolgen.

So erstellen Sie mit epydoc eine HTML-Dokumentation für das Modul quickly.widgets:

epydoc --html quickly.widgets -o quickly_widgets_doc

Sobald dies abgeschlossen ist, öffne quickly_widgets_doc/index.html in Ihrem Webbrowser:

alt text

Oder, wenn Sie diese Dokumentation als PDF bevorzugen:

epydoc --pdf quickly.widgets --name "quickly.widgets" -o quickly_widgets_doc_pdf

Dies erzeugt die Datei quickly_widgets_doc_pdf/api.pdf

alt text

Weitere Informationen zur Verwendung von epydochier .

Ich habe keine Möglichkeit gefunden, diese in ein Format zu konvertieren, das DevHelp verwenden kann. Andernfalls bearbeite ich diese Antwort.

6
Isaiah

Ich kenne kaum ein "Geheimnis", nämlich das pydoc-Tool , das in jeder Python Installation enthalten ist (es müssen also keine zusätzlichen Pakete installiert werden).

Starten Sie einen Webserver, der sofortige Dokumentation aus der Quelle generiert (unter Verwendung der gleichen Techniken wie help() in der Python Konsole), die auf http: // localhost: 8000 / mit:

pydoc -p 8000

Starten Sie den Webserver und eine Tkinter-basierte Benutzeroberfläche mit Suchoptionen.

pydoc -g

Schreiben Sie die Dokumentation für quick.widgets in eine HTML-Datei quick.widgets.html im aktuellen Verzeichnis:

pydoc -w quickly.widgets
4
JanC