Std PythonHelp/de: Difference between revisions

From FreeCAD Documentation
(Created page with "# Wähle die {{MenuCommand|Hilfe → 16px Automatische Python Module Dokumentation}} aus dem Menü. # Klicke auf einen der Verweise, um die Dokume...")
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:


{{Docnav/de
{{Docnav/de
|[[Std_FreeCADPowerUserHub/de|FreeCADHauptAnwenderZentrum]]
|[[Std_FreeCADPowerUserHub/de|DokumentationSkripterstellungMitPython]]
|[[Std_FreeCADForum/de|FreeCADForum]]
|[[Std_FreeCADForum/de|FreeCADForum]]
|[[Std_Help_Menu/de|Std Hilfemenü]]
|[[Std_Help_Menu/de|Std Menü Hilfe]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconR=Std_FreeCADForum.svg
Line 20: Line 20:
==Beschreibung==
==Beschreibung==


Der Befehl '''Std PythonHilfe''' startet einen Webserver, der über einen lokalen Sockel mit dem Standard Internetbrowser des Systems kommuniziert. Der Webserver zeigt Informationen über die verfügbaren [[Python/de|Python]] Module, Klassen und Funktionen von FreeCAD an. Die benötigten Seiten werden automatisch generiert.
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/de|Python]]-Module, Klassen und Funktionen von FreeCAD an. Die benötigten Seiten werden automatisch generiert.


Der Webserver basiert auf dem Python Modul [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] und extrahiert daher die Dokumentationszeichenketten von Python Dateien ({{incode|.py}}) sowie die textuelle Dokumentation, die in den Python Wrappern ({{incode|.xml}}) definiert ist, die den zugrunde liegenden C++ Code offenlegen.
Der Webserver basiert auf dem Python Modul [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] und extrahiert daher die Dokumentationstexte (docstrings) von Python-Dateien ({{incode|.py}}) sowie die Textdokumentation, die in den Python-Wrappern ({{incode|.xml}}) definiert ist, die den zugrunde liegenden C++ Code offenlegen.


==Anwendung==
==Anwendung==


# Wähle die {{MenuCommand|Hilfe → [[Image:Std_PythonHelp.svg|16px]] Automatische Python Module Dokumentation}} aus dem Menü.
# Wähle die {{MenuCommand|Hilfe → [[Image:Std_PythonHelp.svg|16px]] Automatische Python Modul Dokumentation}} aus dem Menü.
# Klicke auf einen der Verweise, um die Dokumentation einer bestimmten Klasse oder Funktion aufzurufen.
# Klicke auf einen der Verweise, um die Dokumentation einer bestimmten Klasse oder Funktion aufzurufen.


{{Docnav/de
{{Docnav/de
|[[Std_FreeCADPowerUserHub/de|FreeCADHauptAnwenderZentrum]]
|[[Std_FreeCADPowerUserHub/de|DokumentationSkripterstellungMitPython]]
|[[Std_FreeCADForum/de|FreeCADForum]]
|[[Std_FreeCADForum/de|FreeCADForum]]
|[[Std_Help_Menu/de|Std Hilfemenü]]
|[[Std_Help_Menu/de|Std Menü Hilfe]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconR=Std_FreeCADForum.svg

Latest revision as of 08:26, 4 April 2022

Std PythonHilfe

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

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. Wähle die Hilfe → Automatische Python Modul Dokumentation aus dem Menü.
  2. Klicke auf einen der Verweise, um die Dokumentation einer bestimmten Klasse oder Funktion aufzurufen.