36.2 Automatisches Erstellen einer Dokumentation – pydoc 
Das in der Standardbibliothek enthaltene Modul pydoc beinhaltet ein Skript namens pydoc bzw. pydoc3, das zum automatischen Erstellen einer Programmdokumentation verwendet wird.
[»] Hinweis
Unter Windows ist das Skript pydoc gegebenenfalls nicht im Systempfad für ausführbare Dateien eingetragen. In diesem Fall finden Sie es im Unterordner Tools der Python-Installation.
Im einfachsten Fall rufen Sie pydoc mit den Modulen als Parameter auf, die Sie dokumentieren möchten. Voraussetzung für eine erfolgreiche Dokumentationsgenerierung ist, dass die übergebenen Module von Python importiert werden können. Die Module müssen also im lokalen Arbeitsverzeichnis oder in einem der in sys.path eingetragenen Verzeichnisse liegen. Als Beispiel erzeugen wir die Dokumentation des Moduls time der Standardbibliothek:
$ pydoc time
Dieser Aufruf generiert eine Dokumentation und zeigt sie ähnlich wie die Built-in Function help in der Konsole an.[ 158 ](Die Built-in Function help verwendet intern übrigens pydoc, um die dargestellten Hilfetexte zu erzeugen. )
Alternativ können Sie einen Pfad zur zu dokumentierenden Programmdatei angeben:
$ pydoc /pfad/zum/modul.py
Neben einem Modul oder Programm kann pydoc auch Dokumentationen für einzelne Elemente eines Programms erstellen, beispielsweise für einzelne Klassen, Funktionen oder Methoden. Dazu wird der entsprechende Name als Parameter angegeben:
$ pydoc time.sleep
Die generierte Dokumentation direkt in der Shell anzuzeigen, ist nur eine der möglichen Darstellungsformen, die pydoc unterstützt. Mithilfe der Option -w lässt sich die Dokumentation im HTML-Format speichern:
$ pydoc -w time
Die erzeugte Datei time.html kann in einem Webbrowser betrachtet werden. Anstatt die Dokumentation zunächst im HTML-Format zu speichern, können Sie über die Option -b einen Webserver starten, der eine Modulübersicht anbietet. In dieser Übersicht finden Sie sowohl Module der Standardbibliothek als auch Module, die sich im lokalen Arbeitsverzeichnis befinden.
$ pydoc -b
Die vom Webserver angebotene Dokumentationsseite wird automatisch im Standardbrowser des Systems geöffnet. Wenn Sie den Webserver auf einem bestimmten Port laufen lassen möchten, können Sie dies über die Option -p tun:
$ pydoc -p 3000
Die beiden Optionen können auch kombiniert werden.
Python 3
