Rheinwerk Computing < openbook >

 
Inhaltsverzeichnis
1 Einleitung
2 Die Programmiersprache Python
Teil I Einstieg in Python
3 Erste Schritte im interaktiven Modus
4 Der Weg zum ersten Programm
5 Kontrollstrukturen
6 Dateien
7 Das Laufzeitmodell
8 Funktionen, Methoden und Attribute
9 Informationsquellen zu Python
Teil II Datentypen
10 Das Nichts – NoneType
11 Operatoren
12 Numerische Datentypen
13 Sequenzielle Datentypen
14 Zuordnungen
15 Mengen
16 Collections
17 Datum und Zeit
18 Aufzählungstypen – Enum
Teil III Fortgeschrittene Programmiertechniken
19 Funktionen
20 Modularisierung
21 Objektorientierung
22 Ausnahmebehandlung
23 Iteratoren
24 Kontextobjekte
25 Manipulation von Funktionen und Methoden
Teil IV Die Standardbibliothek
26 Mathematik
27 Kryptografie
28 Reguläre Ausdrücke
29 Schnittstelle zu Betriebssystem und Laufzeitumgebung
30 Kommandozeilenparameter
31 Dateisystem
32 Parallele Programmierung
33 Datenspeicherung
34 Netzwerkkommunikation
35 Debugging und Qualitätssicherung
36 Dokumentation
Teil V Weiterführende Themen
37 Anbindung an andere Programmiersprachen
38 Distribution von Python-Projekten
39 Grafische Benutzeroberflächen
40 Python als serverseitige Programmiersprache im WWW – ein Einstieg in Django
41 Wissenschaftliches Rechnen
42 Insiderwissen
43 Von Python 2 nach Python 3
A Anhang
Stichwortverzeichnis

Download:
- Beispielprogramme, ca. 464 KB

Jetzt Buch bestellen
Ihre Meinung?

Spacer
<< zurück
Python 3 von Johannes Ernesti, Peter Kaiser
Das umfassende Handbuch
Buch: Python 3

Python 3
Pfeil 36 Dokumentation
Pfeil 36.1 Docstrings
Pfeil 36.2 Automatisches Erstellen einer Dokumentation – pydoc
 
Zum Seitenanfang

36.2    Automatisches Erstellen einer Dokumentation – pydoc Zur vorigen ÜberschriftZur nächsten Überschrift

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.

 


Ihre Meinung

Wie hat Ihnen das Openbook gefallen? Wir freuen uns immer über Ihre Rückmeldung. Schreiben Sie uns gerne Ihr Feedback als E-Mail an kommunikation@rheinwerk-verlag.de.

<< zurück
 Zum Rheinwerk-Shop
Zum Rheinwerk-Shop: Python 3 Python 3
Jetzt Buch bestellen

 Buchempfehlungen
Zum Rheinwerk-Shop: Einstieg in Python
Einstieg in Python


Zum Rheinwerk-Shop: Python. Der Grundkurs
Python. Der Grundkurs


Zum Rheinwerk-Shop: Algorithmen mit Python
Algorithmen mit Python


Zum Rheinwerk-Shop: Objektorientierte Programmierung
Objektorientierte Programmierung


Zum Rheinwerk-Shop: Raspberry Pi. Das umfassende Handbuch
Raspberry Pi. Das umfassende Handbuch


Zum Rheinwerk-Shop: Roboter-Autos mit dem Raspberry Pi
Roboter-Autos mit dem Raspberry Pi


Zum Rheinwerk-Shop: Neuronale Netze programmieren mit Python
Neuronale Netze programmieren mit Python


 Lieferung
Versandkostenfrei bestellen in Deutschland, Österreich und der Schweiz
InfoInfo

 
 


Copyright © Rheinwerk Verlag GmbH 2020
Für Ihren privaten Gebrauch dürfen Sie die Online-Version natürlich ausdrucken. Ansonsten unterliegt das Openbook denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt.
Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

 
[Rheinwerk Computing]

Rheinwerk Verlag GmbH, Rheinwerkallee 4, 53227 Bonn, Tel.: 0228.42150.0, Fax 0228.42150.77, service@rheinwerk-verlag.de

Cookie-Einstellungen ändern