Jump to content

Std PythonHilfe

From FreeCAD Documentation
This page is a translated version of the page Std PythonHelp and the translation is 100% complete.

Std PythonHilfe

Menüeintrag
Hilfe → Dokumentation der Python Module
Arbeitsbereich
Alle
Standardtastenkürzel
Keiner
Eingeführt in Version
-
Siehe auch
Keiner

Beschreibung

Der Befehl Std PythonHilfe startet einen Webserver, der über eine lokale Schnittstelle mit dem voreingestellten Internet-Browser des Systems kommuniziert. Der Webserver zeigt Informationen über die verfügbaren Python-Module, Klassen und Funktionen von FreeCAD an. Die benötigten Seiten werden automatisch generiert.

Der Webserver basiert auf dem Python-Modul pydoc und extrahiert daher die Dokumentationstexte (docstrings) von Python-Dateien (*.py) sowie die Textdokumentation, die in den Python-Wrappern (*.xml) definiert ist, die den zugrunde liegenden C++ Code offenlegen.

Anwendung

  1. Den Menüeintrag Hilfe → Dokumentation der Python-Modul auswählen.
  2. Auf einen der Verweise klicken, um die Dokumentation einer bestimmten Klasse oder Funktion aufzurufen.